dca::VersionInfoResult Class Reference
[DCA Base Package]

#include <base_versioninfo.h>

List of all members.


Detailed Description

Class that contains all details of type dca::VersionInfoResult object.

Can be obtained from a dca::VersionInfoResults object.

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

Definition at line 75 of file base_versioninfo.h.

Public Member Functions

DCA_MODULE_ID_TYPE id () const
VersionInfoResultDetail at (DCA_INDEX_TYPE index) const
 Returns the VersionInfoResultDetail with given index.
VersionInfoResultDetail operator[] (DCA_INDEX_TYPE index) const
 Similar to at() but allows a more C++ style access.
DCA_SIZE_TYPE size () const
 Returns the number of VersionInfoResultDetail objects in the container.
std::string name () const
 Returns the name.

Member Function Documentation

DCA_MODULE_ID_TYPE dca::VersionInfoResult::id (  )  const

Returns the id of the DCA module, e.g. UrlClassification::ID, UpdateModule::ID etc.

Returns:
id of the DCA module - 0 for the DcaInstance (global) itself
VersionInfoResultDetail dca::VersionInfoResult::at ( DCA_INDEX_TYPE  index  )  const

Returns the VersionInfoResultDetail with given index.

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

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

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

Returns the number of VersionInfoResultDetail objects in the container.

Returns:
The size of the container or 0 if the container is empty.
std::string dca::VersionInfoResult::name (  )  const

Returns the name.

Returns:
The name of the VersionInfoResult object

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

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1