dca_wac::WacActions Class Reference

#include <wac_actions.h>

Detailed Description

Definition of a container class for WacAction objects.

A WacActions object can be obtained from a WacApplication object, which will contain all the actions supported by this particular application, or from a WacCategoriesInfo object, which will contain all the actions supported by WacClassification.

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

See also

WacApplication, WacClassificationResult, WacAction

Definition at line 32 of file wac_actions.h.

Public Member Functions
WacAction	at (DCA_INDEX_TYPE index) const
	Returns the WacAction with the given index. More...
WacAction	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 actions in the container. More...
WacAction	byId (DCA_ACTION_ID_TYPE actionId) const
	Returns the action with the given action id. More...

Member Function Documentation

at()

WacAction dca_wac::WacActions::at

(

DCA_INDEX_TYPE

index

)

const

Returns the WacAction with the given index.

Parameters

[in]

index

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

Returns

The WacAction with the given index in the container.

Note

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

operator[]()

WacAction dca_wac::WacActions::operator[]

(

DCA_INDEX_TYPE

index

)

const

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

Parameters

[in]

index

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

Returns

The WacAction 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::WacActions::size

(

)

const

Returns the number of actions in the container.

Returns

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

byId()

WacAction dca_wac::WacActions::byId

(

DCA_ACTION_ID_TYPE

actionId

)

const

Returns the action with the given action id.

Parameters

[in]

actionId

The id of the requested action.

Returns

The WacAction with the given id in the container.

---

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

• wac_actions.h