dca::Groups Class Reference

#include <base_groups.h>

Detailed Description

Definition of a container class for Group objects.

See also

CategoriesInfo, Group

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 33 of file base_groups.h.

Public Member Functions
Group	at (DCA_INDEX_TYPE index) const
	Access to a group with the given index. More...
Group	operator[] (DCA_INDEX_TYPE index) const
	Access to a group with the given index. More...
DCA_SIZE_TYPE	size () const
	The number of items in the container.
Group	byId (DCA_GROUP_ID_TYPE id) const
	Returns the group with the given group id. More...

Member Function Documentation

at()

Group dca::Groups::at

(

DCA_INDEX_TYPE

index

)

const

Access to a group with the given index.

Parameters

[in]

index

The index of the group. Range is from 0 to size() - 1

Returns

A Group object for the given index in the container.

Note

Throws an exception of type dca::ExDca if given index is out of range.

operator[]()

Group dca::Groups::operator[]

(

DCA_INDEX_TYPE

index

)

const

Access to a group with the given index.

Parameters

[in]

index

The index of the group. Range is from 0 to size() - 1

Returns

A Group object for the given index in the container.

Note

Throws an exception of type dca::ExDca if given index is out of range.

byId()

Group dca::Groups::byId

(

DCA_GROUP_ID_TYPE

id

)

const

Returns the group with the given group id.

Parameters

[in]

id

The id of the requested group

Returns

A Group object for the given id in the container.

---

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

• base_groups.h