Class used to hold a group of PvString objects. More...
Public Member Functions | |
PvStringList () | |
Constructor. | |
~PvStringList () | |
Destructor. | |
void | Clear () |
Clears the string list. | |
void | Add (const PvString &aString) |
Adds an item to the list. More... | |
uint32_t | GetSize () const |
Returns the size of the list. More... | |
PvString * | GetItem (uint32_t aIndex) |
Returns a specific item from the list. More... | |
PvString * | operator[] (uint32_t aIndex) |
[] operator. More... | |
PvString * | GetFirst () |
Returns the first item of the list. More... | |
PvString * | GetNext () |
Returns the next item in the list. More... | |
Class used to hold a group of PvString objects.
Used by the persistence objects (PvConfigurationReader, PvConfigurationWriter) to report a list of errors that happened during persistence operations. Since the load and save operations continue even if errors are encountered, more than one error can occur - making it difficult to capture in a single PvResult.
Assign your PvStringList to the persistence object before using it to load or save device, stream, strings or properties.
The list can be accessed iteratively with GetFirst and GetNext or randomly with GetSize, GetItem or the operator[].
void PvStringList::Add | ( | const PvString & | aParameter | ) |
PvString * PvStringList::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.
PvString * PvStringList::GetItem | ( | uint32_t | aIndex | ) |
Returns a specific item from the list.
[in] | aIndex | of the item to get. |
PvString * PvStringList::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.
uint32_t PvStringList::GetSize | ( | ) | const |
Returns the size of the list.
PvString * PvStringList::operator[] | ( | uint32_t | aIndex | ) |
[] operator.
[in] | aIndex | of the item to get. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com