dca_wac::WacTags Class Reference

#include <wac_tags.h>

Detailed Description

    \ingroup wacclassification
    \brief Definition of a container class for WacTag objects.

    Can be obtained from a WacCategoriesInfo object

    Use %WacTags in a similar manner to a std::container. The container can be easily iterated over using size() and operator [].

See also

WacCategoriesInfo, WacApplication, WacTag

Definition at line 30 of file wac_tags.h.

Public Member Functions
WacTag	at (DCA_INDEX_TYPE index) const
	Returns the WacTag with given index. More...
WacTag	operator[] (DCA_INDEX_TYPE index) const
	Similar to at() but allows a more C++ style access. More...
DCA_SIZE_TYPE	size () const
	Returns the number of tags in the container. More...
WacTag	byId (DCA_TAG_ID_TYPE tagid) const
	Returns the tag with the given tag id. More...

Member Function Documentation

at()

WacTag dca_wac::WacTags::at

(

DCA_INDEX_TYPE

index

)

const

Returns the WacTag with given index.

Parameters

[in]

index

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

Returns

The WacTag with the given index in the container.

Note

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

operator[]()

WacTag dca_wac::WacTags::operator[]

(

DCA_INDEX_TYPE

index

)

const

Similar to at() but allows a more C++ style access.

Parameters

[in]

index

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

Returns

The WacTag with the given index in the container.

Note

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

size()

DCA_SIZE_TYPE dca_wac::WacTags::size

(

)

const

Returns the number of tags in the container.

Returns

The size of the container or 0 if the container is empty.

byId()

WacTag dca_wac::WacTags::byId

(

DCA_TAG_ID_TYPE

tagid

)

const

Returns the tag with the given tag id.

Parameters

[in]

tagid

The id of the requested tag

Returns

The WacTag with the given id in the container.

---

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

• wac_tags.h