dca::UpdateResult Class Reference
[DCA Base Package]

#include <base_classes.h>

List of all members.


Detailed Description

Encapsulates one of the results of an update process.

Definition at line 1035 of file base_classes.h.

Public Member Functions

UpdateResultDetail at (DCA_INDEX_TYPE index) const
 Allows access to the details of the result.
UpdateResultDetail operator[] (DCA_INDEX_TYPE index) const
 Identical to at().
DCA_SIZE_TYPE size () const
 Returns the number of available details (if any).
std::string name () const
 Returns the name of the DCA module that is related to current updates.
DCA_MODULE_ID_TYPE id () const
 Returns the module ID for which the updates have been installed.
bool contentUpdated () const
 If true the update(s) include a content update.
bool engineUpdated () const
 If true the update(s) include an engine update.

Member Function Documentation

UpdateResultDetail dca::UpdateResult::at ( DCA_INDEX_TYPE  index  )  const

Allows access to the details of the result.

Parameters:
[in] index The index of the detailed update result. Range is from 0 to size() - 1
Returns:
An UpdateResultDetail object for the given index in the container.
UpdateResultDetail dca::UpdateResult::operator[] ( DCA_INDEX_TYPE  index  )  const

Identical to at().

Parameters:
[in] index The index of the detailed update result. Range is from 0 to size() - 1
Returns:
An UpdateResultDetail object for the given index in the container.

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

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1