dca_interface  6.3.4
dca::UpdateResults Class Reference

#include <base_classes.h>

Detailed Description

Encapsulates the results of an update process.

See also
UpdateModule

Definition at line 997 of file base_classes.h.

Public Member Functions

UpdateResult at (DCA_INDEX_TYPE index) const
 Allows access to the result with given index. More...
 
UpdateResult operator[] (DCA_INDEX_TYPE index) const
 Identical to the at() function. More...
 
DCA_SIZE_TYPE size () const
 Returns the number of results available .
 
bool restartRequired () const
 true if an update has been installed that requires a restart of the DCA, false otherwise.
 

Member Function Documentation

◆ at()

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

Allows access to the result with given index.

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

◆ operator[]()

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

Identical to the at() function.

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

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