dca_interface  6.3.4
dca::VersionInfoResults Class Reference

#include <base_versioninfo.h>

Detailed Description

Class that contains all version information of all initialized DCA modules.

Can be obtained from a call to DcaInstance::getVersionInfo()

See also
VersionInfoResultDetail, VersionInfoResult, DcaInstance::getVersionInfo()

Definition at line 145 of file base_versioninfo.h.

Public Member Functions

VersionInfoResult at (DCA_INDEX_TYPE index) const
 Returns the VersionInfoResult with given index. More...
 
VersionInfoResult 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 VersionInfoResult objects in the container. More...
 

Member Function Documentation

◆ at()

VersionInfoResult dca::VersionInfoResults::at ( DCA_INDEX_TYPE  index) const

Returns the VersionInfoResult with given index.

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

◆ operator[]()

VersionInfoResult dca::VersionInfoResults::operator[] ( DCA_INDEX_TYPE  index) const

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

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

◆ size()

DCA_SIZE_TYPE dca::VersionInfoResults::size ( ) const

Returns the number of VersionInfoResult objects in the container.

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

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