dca_interface  6.3.4
dca::UpdateResult Class Reference

#include <base_classes.h>

Detailed Description

Encapsulates one of the results of an update process.

Definition at line 1036 of file base_classes.h.

Public Member Functions

UpdateResultDetail at (DCA_INDEX_TYPE index) const
 Allows access to the details of the result. More...
 
UpdateResultDetail operator[] (DCA_INDEX_TYPE index) const
 Identical to at(). More...
 
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

◆ at()

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

Allows access to the details of the result.

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

◆ operator[]()

UpdateResultDetail dca::UpdateResult::operator[] ( DCA_INDEX_TYPE  index) const

Identical to at().

Parameters
[in]indexThe 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: