dca::CategoriesInfo Class Reference
[DCA Base Package]

#include <base_categoriesinfo.h>

List of all members.


Detailed Description

A container class that allows access to the contained Categories, Groups and Locales.

See also:
Categories, Groups, Locales, DcaInstance::getCategoriesInfo

The following sample code shows how to iterate over the data contained in a CategoriesInfo object:

void EnumerateCategoriesInfo( const dca::DcaInstance& myDca )
{
        // assume we have a successfully initialized DcaInstance myDca

        // get internal DCA categories info related to URL signature database...
        const dca::CategoriesInfo myCategoriesInfo = myDca.getCategoriesInfo( DCA_CAT_INFO_TYPE_URL );

        // enumerate categories...
        {
                const dca::Categories myCategories = myCategoriesInfo.getCategories();
                const DCA_SIZE_TYPE numOfCategories = myCategories.size();
                for( DCA_INDEX_TYPE i = 0; i < numOfCategories; ++i ) {
                        dca::Category myCategory = myCategories[ i ];
                        cout << (i+1)
                             << ") Category name=" << myCategory.name( "" )
                                 <<      ", id=" << myCategory.id()
                                 <<      ", groupId=" << myCategory.groupId() << endl;
                }
        }

        // enumerate groups...
        {
                const dca::Groups myGroups = myCategoriesInfo.getGroups();
                const DCA_SIZE_TYPE numOfGroups = myGroups.size();
                for( DCA_INDEX_TYPE i = 0; i < numOfGroups; ++i ) {
                        dca::Group myGroup = myGroups[ i ];
                        cout << (i+1)
                                 << ") Group name=" << myGroup.name( "" )
                                 << ", id=" << myGroup.id() << endl;
                }
        }

        // enumerate locales...
        {
                const dca::Locales myLocales = myCategoriesInfo.getLocales();
                const DCA_SIZE_TYPE numOfLocales = myLocales.size();
                for( DCA_INDEX_TYPE i = 0; i < numOfLocales; ++i ) {
                        dca::Locale myLocale = myLocales[ i ];
                        cout << (i+1)
                                 << ") Locale displayName='" << myLocale.displayName()
                                 << "', languageId='" << myLocale.languageId() << "'"
                                 << endl;
                }
        }
}

Definition at line 39 of file base_categoriesinfo.h.

Public Member Functions

Categories getCategories () const
 Returns the contained Categories.
Groups getGroups () const
 Returns the contained Groups.
Locales getLocales () const
 Returns the contained Locales.

The documentation for this class was generated from the following file:

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1