Class used to hold a group of PvGenParameter pointers. More...
Public Member Functions | |
PvGenParameterList () | |
Constructor. | |
~PvGenParameterList () | |
Destructor. | |
void | Clear () |
Clears the parameter list. | |
void | Add (PvGenParameter *aParameter) |
Adds an item to the parameter list. More... | |
uint32_t | GetSize () const |
Returns the size of the list. More... | |
PvGenParameter * | GetItem (uint32_t aIndex) |
Returns a specific item from the list. More... | |
PvGenParameter * | operator[] (uint32_t aIndex) |
[] operator. More... | |
PvGenParameter * | GetFirst () |
Returns the first item of the list. More... | |
PvGenParameter * | GetNext () |
Returns the next item in the list. More... | |
Class used to hold a group of PvGenParameter pointers.
Unlike the PvGenParameterArray, this class does not wrap a node map. It only contains pointers to PvGenParameter objects living in a PvGenParameterArray of their own.
To use this class, see PvGenParameter GetSelectedParameters and GetSelectingParameters. It is used by the eBUS SDK to return a list of pointers to parameters whithin a PvGenParameterArray.
The list can be accessed iteratively with GetFirst and GetNext or randomly with GetSize, GetItem or the operator[].
void PvGenParameterList::Add | ( | PvGenParameter * | aParameter | ) |
Adds an item to the parameter list.
[in] | aParameter | The PvGenParameter pointer to add to the list. |
PvGenParameter * PvGenParameterList::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.
PvGenParameter * PvGenParameterList::GetItem | ( | uint32_t | aIndex | ) |
Returns a specific item from the list.
[in] | aIndex | of the item to get. |
PvGenParameter * PvGenParameterList::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 PvGenParameterList::GetSize | ( | ) | const |
Returns the size of the list.
PvGenParameter * PvGenParameterList::operator[] | ( | uint32_t | aIndex | ) |
[] operator.
[in] | aIndex | of the item to get. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com