Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenParameterList Class Reference

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...
 
PvGenParameterGetItem (uint32_t aIndex)
 Returns a specific item from the list. More...
 
PvGenParameteroperator[] (uint32_t aIndex)
 [] operator. More...
 
PvGenParameterGetFirst ()
 Returns the first item of the list. More...
 
PvGenParameterGetNext ()
 Returns the next item in the list. More...
 

Detailed Description

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[].

How to use PvGenParameterList with PvGenParameter

PvGenParameter *lGenParameter = // ...get a parameter from a PvGenParameterArray
lGenParameter->GetSelectedParameters( lList );
PvGenParameter *lP = lList.GetFirst();
while ( lP != NULL )
{
// Do something with lP
// ...
lP = lList.GetNext();
}

Member Function Documentation

void PvGenParameterList::Add ( PvGenParameter aParameter)

Adds an item to the parameter list.

Note
Adding an item in the list resets the GetFirst, GetNext internal iterator.
Parameters
[in]aParameterThe 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.

Returns
Pointer to the first item in the list, NULL if the list is empty.
PvGenParameter * PvGenParameterList::GetItem ( uint32_t  aIndex)

Returns a specific item from the list.

Returns
Index of the requested PvGenParameter pointer.
Parameters
[in]aIndexof 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.

Returns
Pointer to the next item in the list. NULL if the end of the list is reached.
uint32_t PvGenParameterList::GetSize ( ) const

Returns the size of the list.

Returns
The size, or count of items contained in the list.
PvGenParameter * PvGenParameterList::operator[] ( uint32_t  aIndex)

[] operator.

Returns
Index of the requested PvGenParameter pointer.
Parameters
[in]aIndexof the item to get.

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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com