This class manages a group of nConfigEntry objects that are related.
More...
#include <nConfigGroup.h>
Inherits Observable.
This class manages a group of nConfigEntry objects that are related.
This class extends Observable so that if new nConfigEntry objects are added to this group the Observer will be notified with the new nConfigEntry
| com::pcbsys::nirvana::nAdminAPI::nConfigGroup::nConfigGroup |
( |
fConfigObject * |
pCo | ) |
|
Constructs a new nConfigGroup.
- Parameters
-
| *pCo | the fConfigObject for this group |
| virtual bool com::pcbsys::nirvana::nAdminAPI::nConfigGroup::Equals |
( |
nConfigGroup * |
pItem | ) |
|
|
virtual |
Compares this object with the passed object.
For internal use only
- Parameters
-
- Returns
- True if this object is equal to the passed long
| bool com::pcbsys::nirvana::nAdminAPI::nConfigGroup::Equals |
( |
longlong |
aLong | ) |
|
Compares this object with the passed object.
For internal use only
- Parameters
-
| aLong | long to compare against |
- Returns
- True if this object is equal to the passed long
| virtual nConfigEntry* com::pcbsys::nirvana::nAdminAPI::nConfigGroup::find |
( |
const std::string & |
itemName | ) |
|
|
virtual |
Finds a nConfigEntry that matches the name specified from within this group.
- See Also
- nConfigEntry
- Parameters
-
- Returns
- the nConfigEntry object found or null if the name does not exist within the group
| virtual const std::string& com::pcbsys::nirvana::nAdminAPI::nConfigGroup::getDescription |
( |
| ) |
|
|
virtual |
Retrieves the description of this group.
- Returns
- the description of this config group as a String
| virtual fSortedList<std::string, nConfigEntry*>& com::pcbsys::nirvana::nAdminAPI::nConfigGroup::getItems |
( |
| ) |
|
|
virtual |
Returns the group as an Enumeration of all the nConfigEntry objects that the group consists of.
- Returns
- an fSortedList of string, nConfigEntry* pairs.
| virtual const std::string& com::pcbsys::nirvana::nAdminAPI::nConfigGroup::getName |
( |
| ) |
|
|
virtual |
Retrieve this groups unique name.
- Returns
- String name
| virtual int com::pcbsys::nirvana::nAdminAPI::nConfigGroup::getType |
( |
| ) |
|
|
virtual |
Returns the type of this object.
- Returns
- the type of the object.
| virtual bool com::pcbsys::nirvana::nAdminAPI::nConfigGroup::isReadOnly |
( |
| ) |
|
|
virtual |
Returns whether this config group is read only.
- Returns
- bool value representing if it's read only
| virtual int com::pcbsys::nirvana::nAdminAPI::nConfigGroup::Length |
( |
| ) |
|
|
virtual |
Returns the length of the configuration group, ie the number of items.
- Returns
- The number of config entries in this group
| virtual bool com::pcbsys::nirvana::nAdminAPI::nConfigGroup::lessThan |
( |
nConfigGroup * |
pItem | ) |
|
|
virtual |
Compares this object with the passed object.
For internal use only
- Parameters
-
| aLong | long to compare against |
- Returns
- True if this object is less to the passed long
| virtual bool com::pcbsys::nirvana::nAdminAPI::nConfigGroup::lessThan |
( |
longlong |
aLong | ) |
|
|
virtual |
Compares this object with the passed object.
For internal use only
- Parameters
-
| aLong | long to compare against |
- Returns
- True if this object is less to the passed long
