Class used to hold a group of PvProperty objects. More...
Public Member Functions | |
PvPropertyList () | |
Constructor. | |
~PvPropertyList () | |
Destructor. | |
void | Clear () |
Clears the Property list. | |
void | Add (const PvProperty &aString) |
Adds an item to the list. More... | |
uint32_t | GetSize () const |
Returns the size of the list. More... | |
PvProperty * | GetItem (uint32_t aIndex) |
Returns a specific item from the list. More... | |
PvProperty * | operator[] (uint32_t aIndex) |
[] operator. More... | |
PvProperty * | GetFirst () |
Returns the first item of the list. More... | |
PvProperty * | GetNext () |
Returns the next item in the list. More... | |
PvProperty * | GetProperty (const PvString &aName) |
Returns a property from its name. More... | |
Class used to hold a group of PvProperty objects.
A list of property can be persisted as a single entity in a PvConfigurationReader or PvConfigurationWriter. It allows grouping generic parameters together - the alternative would have been to save (and then load) individual strings.
The list can be accessed iteratively with GetFirst and GetNext or randomly with GetSize, GetItem or the operator[].
void PvPropertyList::Add | ( | const PvProperty & | aParameter | ) |
Adds an item to the list.
[in] | aParameter | The PvProperty to add to the list. |
PvProperty * PvPropertyList::GetFirst | ( | ) |
Returns the first item of the list.
Sets the internal iterator to the first item. Subsequent calls to GetNext can be used to scroll through the list.
PvProperty * PvPropertyList::GetItem | ( | uint32_t | aIndex | ) |
Returns a specific item from the list.
[in] | aIndex | of the item to get. |
PvProperty * PvPropertyList::GetNext | ( | ) |
Returns the next item in the list.
Calling this method advances the internal iterator to the next item in the list.
NULL is returned if the end of the list is reached.
If GetFirst is not called before GetNext, the first call to GetNext returns the first item in the list.
PvProperty * PvPropertyList::GetProperty | ( | const PvString & | aName | ) |
Returns a property from its name.
aName | [in] Property name. |
uint32_t PvPropertyList::GetSize | ( | ) | const |
Returns the size of the list.
PvProperty * PvPropertyList::operator[] | ( | uint32_t | aIndex | ) |
[] operator.
[in] | aIndex | of the item to get. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com