GenICam feature array. More...
Public Member Functions | |
PvGenParameterArray () | |
Constructor. | |
virtual | ~PvGenParameterArray () |
Destructor. | |
uint32_t | GetCount () const |
Get the number of parameters (PvGenParameter objects) in the array. More... | |
PvGenParameter * | Get (uint32_t aIndex) |
Get a parameter (PvGenParameter object) from the array (using array position). More... | |
PvGenParameter * | Get (const PvString &aName) |
Get a parameter (PvGenParameter object) from the array (using parameter name). More... | |
PvGenParameter * | operator[] (uint32_t aIndex) |
Get a parameter (PvGenParameter object) from the array (using array position). More... | |
PvGenParameter * | operator[] (const PvString &aName) |
Get a parameter (PvGenParameter object) from the array (using parameter name). More... | |
uint32_t | GetCategoryCount () const |
Get the number of categories (PvGenCategory objects) in the array. More... | |
PvGenCategory * | GetCategory (uint32_t aIndex) |
Get a category (PvGenCategory object) from the array (using array position). More... | |
PvGenCategory * | GetCategory (const PvString &aName) |
Get a category (PvGenCategory object) from the array (using category name). More... | |
PvResult | InvalidateCache () |
Invalidates the cache of the GenICam parameter array. More... | |
GenApi_3_3::INodeMap * | GetNodeMap () |
Returns the interface of the GenApi node map wrapped by this PvGenParameterArray. More... | |
PvGenInteger * | GetInteger (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenInteger. More... | |
PvGenFloat * | GetFloat (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenFloat. More... | |
PvGenEnum * | GetEnum (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenEnum. More... | |
PvGenBoolean * | GetBoolean (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenBoolean. More... | |
PvGenCommand * | GetCommand (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenCommand. More... | |
PvGenString * | GetString (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenString. More... | |
PvGenRegister * | GetRegister (const PvString &aName) |
Helper method returning a PvGenParameter casted as a PvGenRegister. More... | |
PvResult | GetIntegerValue (const PvString &aName, int64_t &aValue) |
Helper method used to directly read an integer parameter value of this parameter array. More... | |
PvResult | SetIntegerValue (const PvString &aName, int64_t aValue) |
Helper method used to directly write an integer parameter value of this parameter array. More... | |
PvResult | GetFloatValue (const PvString &aName, double &aValue) |
Helper method used to directly read a float parameter value of this parameter array. More... | |
PvResult | SetFloatValue (const PvString &aName, double aValue) |
Helper method used to directly write a float parameter value of this parameter array. More... | |
PvResult | GetEnumValue (const PvString &aName, PvString &aValue) |
Helper method used to directly read an enumeration parameter value (as a string) of this parameter array. More... | |
PvResult | GetEnumValue (const PvString &aName, int64_t &aValue) |
Helper method used to directly read an enumeration parameter value (as an integer) of this parameter array. More... | |
PvResult | SetEnumValue (const PvString &aName, const PvString &aValue) |
Helper method used to directly write an enumeration parameter value (as a string) of this parameter array. More... | |
PvResult | SetEnumValue (const PvString &aName, int64_t aValue) |
Helper method used to directly write an enumeration parameter value (as an integer) of this parameter array. More... | |
PvResult | GetBooleanValue (const PvString &aName, bool &aValue) |
Helper method used to directly read a boolean parameter value of this parameter array. More... | |
PvResult | SetBooleanValue (const PvString &aName, bool aValue) |
Helper method used to directly write a boolean parameter value of this parameter array. More... | |
PvResult | GetStringValue (const PvString &aName, PvString &aValue) |
Helper method used to directly read a string parameter value of this parameter array. More... | |
PvResult | SetStringValue (const PvString &aName, const PvString &aValue) |
Helper method used to directly write a string parameter value of this parameter array. More... | |
PvResult | ExecuteCommand (const PvString &aName) |
Helper method used to directly execute a command parameter of this parameter array. More... | |
PvResult | GetIntegerRange (const PvString &aName, int64_t &aMin, int64_t &aMax) |
Helper method used to directly retrieve the range of an integer parameter. More... | |
PvResult | GetFloatRange (const PvString &aName, double &aMin, double &aMax) |
Helper method used to directly retrieve the range of a float parameter. More... | |
PvResult | AttachDataChunks (uint8_t *aBuffer, uint32_t aBufferLength) |
Attaches a payload containing data chunks to a GenICam node map. More... | |
PvResult | DetachDataChunks () |
Detach previously attached data chunks. More... | |
PvGenAccessMode | GetAccessMode () const |
Returns the access mode of the port of the GenICam node map. More... | |
PvResult | Poll () |
Invalidates nodes having reach their defined polling time since last update. More... | |
Friends | |
class | PvGenFile |
class | PvConfigurationWriter |
class | PvConfigurationReader |
GenICam feature array.
To control features:
To control features (using a GUI):
In some cases, you may want to know when a feature value or attribute changes without using CPU-intensive polling to regularly check (and re-check) the feature's value.
To create a callback that runs when the feature's value changes:
PvResult PvGenParameterArray::AttachDataChunks | ( | uint8_t * | aBuffer, |
uint32_t | aBufferLength | ||
) |
Attaches a payload containing data chunks to a GenICam node map.
Takes the content of a PvBuffer and attempts to parse the chunks from the end of the buffer. Chunk IDs from the buffer matching chunk IDs in the node map are available through the node map once the buffer is attached.
Using GenICam instead of the PvBuffer raw chunk methods access allows to access the chunks as structured data, as long as the chunks are described in the GenICam XML file of the device.
[in] | aBuffer | Pointer to the buffer data (usually PvBuffer::GetRawData) |
[in] | aBufferLength | Size of the buffer without padding (usually PvBuffer::GetPayloadSize) |
PvResult PvGenParameterArray::DetachDataChunks | ( | ) |
Detach previously attached data chunks.
Helper method used to directly execute a command parameter of this parameter array.
[in] | aName | Name of the parameter to execute. |
PvGenParameter * PvGenParameterArray::Get | ( | uint32_t | aIndex | ) |
Get a parameter (PvGenParameter object) from the array (using array position).
[in] | aIndex | The parameter's position in the array. The valid range for aIndex is: 0 =< aIndex < GetCount. |
PvGenParameter * PvGenParameterArray::Get | ( | const PvString & | aName | ) |
Get a parameter (PvGenParameter object) from the array (using parameter name).
[in] | aName | The parameter's name. See PvGenParameter::GetName. |
PvGenAccessMode PvGenParameterArray::GetAccessMode | ( | ) | const |
Returns the access mode of the port of the GenICam node map.
PvGenBoolean * PvGenParameterArray::GetBoolean | ( | const PvString & | aName | ) |
Helper method returning a PvGenParameter casted as a PvGenBoolean.
Returns NULL if the parameter does not exist in the node map or the parameter is not a boolean.
[in] | aName | Name of the parameter. |
Helper method used to directly read a boolean parameter value of this parameter array.
[in] | aName | Name of the parameter to read the value from. |
[out] | aValue | Value read from the parameter. |
PvGenCategory * PvGenParameterArray::GetCategory | ( | uint32_t | aIndex | ) |
Get a category (PvGenCategory object) from the array (using array position).
[in] | aIndex | The category's position in the array. The valid range for aIndex is: 0 =< aIndex < GetCategoryCount. |
PvGenCategory * PvGenParameterArray::GetCategory | ( | const PvString & | aName | ) |
Get a category (PvGenCategory object) from the array (using category name).
[in] | aName | The category's name. See PvGenCategory::GetName. |
uint32_t PvGenParameterArray::GetCategoryCount | ( | ) | const |
Get the number of categories (PvGenCategory objects) in the array.
PvGenCommand * PvGenParameterArray::GetCommand | ( | const PvString & | aName | ) |
Helper method returning a PvGenParameter casted as a PvGenCommand.
Returns NULL if the parameter does not exist in the node map or the parameter is not a command.
[in] | aName | Name of the parameter. |
uint32_t PvGenParameterArray::GetCount | ( | ) | const |
Get the number of parameters (PvGenParameter objects) in the array.
Helper method returning a PvGenParameter casted as a PvGenEnum.
Returns NULL if the parameter does not exist in the node map or the parameter is not an enumeration.
[in] | aName | Name of the parameter. |
Helper method used to directly read an enumeration parameter value (as a string) of this parameter array.
[in] | aName | Name of the parameter to read the value from. |
[out] | aValue | Value read from the parameter, string representation. |
Helper method used to directly read an enumeration parameter value (as an integer) of this parameter array.
[in] | aName | Name of the parameter to read the value from. |
[out] | aValue | Value read from the parameter, integer representation. |
PvGenFloat * PvGenParameterArray::GetFloat | ( | const PvString & | aName | ) |
Helper method returning a PvGenParameter casted as a PvGenFloat.
Returns NULL if the parameter does not exist in the node map or the parameter is not a float.
[in] | aName | Name of the parameter. |
PvResult PvGenParameterArray::GetFloatRange | ( | const PvString & | aName, |
double & | aMin, | ||
double & | aMax | ||
) |
Helper method used to directly retrieve the range of a float parameter.
[in] | aName | Name of the parameter. |
[out] | aMin | Minimum. |
[out] | aMax | Maximum. |
Helper method used to directly read a float parameter value of this parameter array.
[in] | aName | Name of the parameter to read the value from. |
[out] | aValue | Value read from the parameter. |
PvGenInteger * PvGenParameterArray::GetInteger | ( | const PvString & | aName | ) |
Helper method returning a PvGenParameter casted as a PvGenInteger.
Returns NULL if the parameter does not exist in the node map or the parameter is not an integer.
[in] | aName | Name of the parameter. |
PvResult PvGenParameterArray::GetIntegerRange | ( | const PvString & | aName, |
int64_t & | aMin, | ||
int64_t & | aMax | ||
) |
Helper method used to directly retrieve the range of an integer parameter.
[in] | aName | Name of the parameter. |
[out] | aMin | Minimum. |
[out] | aMax | Maximum. |
Helper method used to directly read an integer parameter value of this parameter array.
[in] | aName | Name of the parameter to read the value from. |
[out] | aValue | Value read from the parameter. |
PV_GENAPI_NS::INodeMap * PvGenParameterArray::GetNodeMap | ( | ) |
Returns the interface of the GenApi node map wrapped by this PvGenParameterArray.
For advanced use only.
GenApi headers and link libraries are not provided with the eBUS SDK. In order to use the GenApi node map provided by this method, install the GenApi SDK.
PvGenRegister * PvGenParameterArray::GetRegister | ( | const PvString & | aName | ) |
Helper method returning a PvGenParameter casted as a PvGenRegister.
Returns NULL if the parameter does not exist in the node map or the parameter is not a register.
[in] | aName | Name of the parameter. |
PvGenString * PvGenParameterArray::GetString | ( | const PvString & | aName | ) |
Helper method returning a PvGenParameter casted as a PvGenString.
Returns NULL if the parameter does not exist in the node map or the parameter is not a string.
[in] | aName | Name of the parameter. |
Helper method used to directly read a string parameter value of this parameter array.
[in] | aName | Name of the parameter to read the value from. |
[out] | aValue | Value read from the parameter. |
PvResult PvGenParameterArray::InvalidateCache | ( | ) |
Invalidates the cache of the GenICam parameter array.
PvGenParameter * PvGenParameterArray::operator[] | ( | uint32_t | aIndex | ) |
Get a parameter (PvGenParameter object) from the array (using array position).
[in] | aIndex | The parameter's position in the array. The valid range for aIndex is: 0 =< aIndex < GetCount. |
PvGenParameter * PvGenParameterArray::operator[] | ( | const PvString & | aName | ) |
Get a parameter (PvGenParameter object) from the array (using parameter name).
[in] | aName | The parameter's name. See PvGenParameter::GetName. |
PvResult PvGenParameterArray::Poll | ( | ) |
Invalidates nodes having reach their defined polling time since last update.
Goes through all parameters having polling times defined and invalidates those that need to be invalidated based on the last time they were invalidated.
Helper method used to directly write a boolean parameter value of this parameter array.
[in] | aName | Name of the parameter to write the value to. |
[out] | aValue | Value written to the parameter. |
Helper method used to directly write an enumeration parameter value (as a string) of this parameter array.
[in] | aName | Name of the parameter to write the value to. |
[out] | aValue | Value written to the parameter. |
Helper method used to directly write an enumeration parameter value (as an integer) of this parameter array.
[in] | aName | Name of the parameter to write the value to. |
[out] | aValue | Value written to the parameter. |
Helper method used to directly write a float parameter value of this parameter array.
[in] | aName | Name of the parameter to write the value to. |
[out] | aValue | Value written to the parameter. |
Helper method used to directly write an integer parameter value of this parameter array.
[in] | aName | Name of the parameter to write the value to. |
[out] | aValue | Value written to the parameter. |
Helper method used to directly write a string parameter value of this parameter array.
[in] | aName | Name of the parameter to write the value to. |
[out] | aValue | Value written to the parameter. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com