dca_interface  6.3.4
dca_wac::WacApplications Class Reference

#include <wac_applications.h>

Detailed Description

Definition of a container class for WacApplication objects.

Can be obtained from a WacCategoriesInfo object

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

See also
WacCategoriesInfo, WacApplication

Definition at line 30 of file wac_applications.h.

Public Member Functions

WacApplication at (DCA_INDEX_TYPE index) const
 Returns the WacApplication with given index. More...
 
WacApplication 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 applications in the container. More...
 
WacApplication byId (DCA_APPLICATION_ID_TYPE appid) const
 Returns the application with the given application id. More...
 

Member Function Documentation

◆ at()

WacApplication dca_wac::WacApplications::at ( DCA_INDEX_TYPE  index) const

Returns the WacApplication with given index.

Parameters
[in]indexThe index of the application. Range is from 0 to size() - 1
Returns
The WacApplication with the given index in the container.
Note
Throws an exception of type dca::ExDca if the given index is out of range.

◆ operator[]()

WacApplication dca_wac::WacApplications::operator[] ( DCA_INDEX_TYPE  index) const

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

Parameters
[in]indexThe index of the application. Range is from 0 to size() - 1
Returns
The WacApplication 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::WacApplications::size ( ) const

Returns the number of applications in the container.

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

◆ byId()

WacApplication dca_wac::WacApplications::byId ( DCA_APPLICATION_ID_TYPE  appid) const

Returns the application with the given application id.

Parameters
[in]appidThe id of the requested application
Returns
The WacApplication with the given id in the container.

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