Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenParameterArray Class Reference

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...
 
PvGenParameterGet (uint32_t aIndex)
 Get a parameter (PvGenParameter object) from the array (using array position). More...
 
PvGenParameterGet (const PvString &aName)
 Get a parameter (PvGenParameter object) from the array (using parameter name). More...
 
PvGenParameteroperator[] (uint32_t aIndex)
 Get a parameter (PvGenParameter object) from the array (using array position). More...
 
PvGenParameteroperator[] (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...
 
PvGenCategoryGetCategory (uint32_t aIndex)
 Get a category (PvGenCategory object) from the array (using array position). More...
 
PvGenCategoryGetCategory (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...
 
PvGenIntegerGetInteger (const PvString &aName)
 Helper method returning a PvGenParameter casted as a PvGenInteger. More...
 
PvGenFloatGetFloat (const PvString &aName)
 Helper method returning a PvGenParameter casted as a PvGenFloat. More...
 
PvGenEnumGetEnum (const PvString &aName)
 Helper method returning a PvGenParameter casted as a PvGenEnum. More...
 
PvGenBooleanGetBoolean (const PvString &aName)
 Helper method returning a PvGenParameter casted as a PvGenBoolean. More...
 
PvGenCommandGetCommand (const PvString &aName)
 Helper method returning a PvGenParameter casted as a PvGenCommand. More...
 
PvGenStringGetString (const PvString &aName)
 Helper method returning a PvGenParameter casted as a PvGenString. More...
 
PvGenRegisterGetRegister (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
 

Detailed Description

GenICam feature array.

Controlling features (programmatically)

To control features:

  1. Get the list of features. Use one of the following:
  2. Get a feature. Use Get.
  3. Get the feature's type. Use PvGenParameter::GetType.
  4. Optionally:

Controlling features (using a GUI)

To control features (using a GUI):

  • See GenICam browser dialog documentation.

Running code when a feature's value changes

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:

  1. Get the feature. See Controlling features.
  2. Create a subclass of PvGenEventSink.
  3. Call PvGenParameter::RegisterEventSink to be notified when that parameter is updated.
  4. In your new class, override PvGenEventSink::OnParameterUpdate.

Member Function Documentation

◆ AttachDataChunks()

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.

Parameters
[in]aBufferPointer to the buffer data (usually PvBuffer::GetRawData)
[in]aBufferLengthSize of the buffer without padding (usually PvBuffer::GetPayloadSize)
Returns
Includes:

◆ DetachDataChunks()

PvResult PvGenParameterArray::DetachDataChunks ( )

Detach previously attached data chunks.

Returns
Includes:

◆ ExecuteCommand()

PvResult PvGenParameterArray::ExecuteCommand ( const PvString aName)

Helper method used to directly execute a command parameter of this parameter array.

Parameters
[in]aNameName of the parameter to execute.
Returns
Includes:

◆ Get() [1/2]

PvGenParameter * PvGenParameterArray::Get ( const PvString aName)

Get a parameter (PvGenParameter object) from the array (using parameter name).

Parameters
[in]aNameThe parameter's name. See PvGenParameter::GetName.
Returns
The parameter (PvGenParameter object), or NULL if the name does not match any paramaters in the array.

◆ Get() [2/2]

PvGenParameter * PvGenParameterArray::Get ( uint32_t  aIndex)

Get a parameter (PvGenParameter object) from the array (using array position).

Parameters
[in]aIndexThe parameter's position in the array. The valid range for aIndex is: 0 =< aIndex < GetCount.
Returns
The parameter (PvGenParameter object), or NULL if the index is out of bounds.

◆ GetAccessMode()

PvGenAccessMode PvGenParameterArray::GetAccessMode ( ) const

Returns the access mode of the port of the GenICam node map.

Returns
Includes:
  • PvGenAccessModeReadOnly
  • PvGenAccessModeReadWrite
  • PvGenAccessModeNotAvailable

◆ GetBoolean()

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenBoolean parameter pointer from the parameter array.

◆ GetBooleanValue()

PvResult PvGenParameterArray::GetBooleanValue ( const PvString aName,
bool &  aValue 
)

Helper method used to directly read a boolean parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to read the value from.
[out]aValueValue read from the parameter.
Returns
Includes:

◆ GetCategory() [1/2]

PvGenCategory * PvGenParameterArray::GetCategory ( const PvString aName)

Get a category (PvGenCategory object) from the array (using category name).

Parameters
[in]aNameThe category's name. See PvGenCategory::GetName.
Returns
The category (PvGenCategory object), or NULL if the name does not match any categories in the array.

◆ GetCategory() [2/2]

PvGenCategory * PvGenParameterArray::GetCategory ( uint32_t  aIndex)

Get a category (PvGenCategory object) from the array (using array position).

Parameters
[in]aIndexThe category's position in the array. The valid range for aIndex is: 0 =< aIndex < GetCategoryCount.
Returns
The parameter (PvGenCategory object), or NULL if the index is out of bounds.

◆ GetCategoryCount()

uint32_t PvGenParameterArray::GetCategoryCount ( ) const

Get the number of categories (PvGenCategory objects) in the array.

Returns
The number of categories (PvGenCategory objects) in the array.

◆ GetCommand()

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenBoolean parameter pointer from the parameter array.

◆ GetCount()

uint32_t PvGenParameterArray::GetCount ( ) const

Get the number of parameters (PvGenParameter objects) in the array.

Returns
The number of parameters (PvGenParameter objects) in the array.

◆ GetEnum()

PvGenEnum * PvGenParameterArray::GetEnum ( const PvString aName)

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenEnum parameter pointer from the parameter array.

◆ GetEnumValue() [1/2]

PvResult PvGenParameterArray::GetEnumValue ( const PvString aName,
int64_t &  aValue 
)

Helper method used to directly read an enumeration parameter value (as an integer) of this parameter array.

Parameters
[in]aNameName of the parameter to read the value from.
[out]aValueValue read from the parameter, integer representation.
Returns
Includes:

◆ GetEnumValue() [2/2]

PvResult PvGenParameterArray::GetEnumValue ( const PvString aName,
PvString aValue 
)

Helper method used to directly read an enumeration parameter value (as a string) of this parameter array.

Parameters
[in]aNameName of the parameter to read the value from.
[out]aValueValue read from the parameter, string representation.
Returns
Includes:

◆ GetFloat()

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenFloat parameter pointer from the parameter array.

◆ GetFloatRange()

PvResult PvGenParameterArray::GetFloatRange ( const PvString aName,
double &  aMin,
double &  aMax 
)

Helper method used to directly retrieve the range of a float parameter.

Parameters
[in]aNameName of the parameter.
[out]aMinMinimum.
[out]aMaxMaximum.
Returns
Includes:

◆ GetFloatValue()

PvResult PvGenParameterArray::GetFloatValue ( const PvString aName,
double &  aValue 
)

Helper method used to directly read a float parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to read the value from.
[out]aValueValue read from the parameter.
Returns
Includes:

◆ GetInteger()

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenInteger parameter pointer from the parameter array.

◆ GetIntegerRange()

PvResult PvGenParameterArray::GetIntegerRange ( const PvString aName,
int64_t &  aMin,
int64_t &  aMax 
)

Helper method used to directly retrieve the range of an integer parameter.

Parameters
[in]aNameName of the parameter.
[out]aMinMinimum.
[out]aMaxMaximum.
Returns
Includes:

◆ GetIntegerValue()

PvResult PvGenParameterArray::GetIntegerValue ( const PvString aName,
int64_t &  aValue 
)

Helper method used to directly read an integer parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to read the value from.
[out]aValueValue read from the parameter.
Returns
Includes:

◆ GetNodeMap()

PV_GENAPI_NS::INodeMap * PvGenParameterArray::GetNodeMap ( )

Returns the interface of the GenApi node map wrapped by this PvGenParameterArray.

Returns
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.

◆ GetRegister()

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenRegister parameter pointer from the parameter array.

◆ GetString()

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.

Parameters
[in]aNameName of the parameter.
Returns
PvGenString parameter pointer from the parameter array.

◆ GetStringValue()

PvResult PvGenParameterArray::GetStringValue ( const PvString aName,
PvString aValue 
)

Helper method used to directly read a string parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to read the value from.
[out]aValueValue read from the parameter.
Returns
Includes:

◆ InvalidateCache()

PvResult PvGenParameterArray::InvalidateCache ( )

Invalidates the cache of the GenICam parameter array.

Returns
Includes:

◆ operator[]() [1/2]

PvGenParameter * PvGenParameterArray::operator[] ( const PvString aName)

Get a parameter (PvGenParameter object) from the array (using parameter name).

Parameters
[in]aNameThe parameter's name. See PvGenParameter::GetName.
Returns
The parameter (PvGenParameter object), or NULL if the name does not match any paramaters in the array.

◆ operator[]() [2/2]

PvGenParameter * PvGenParameterArray::operator[] ( uint32_t  aIndex)

Get a parameter (PvGenParameter object) from the array (using array position).

Parameters
[in]aIndexThe parameter's position in the array. The valid range for aIndex is: 0 =< aIndex < GetCount.
Returns
The parameter (PvGenParameter object), or NULL if the index is out of bounds.

◆ Poll()

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.

Returns
Includes:

◆ SetBooleanValue()

PvResult PvGenParameterArray::SetBooleanValue ( const PvString aName,
bool  aValue 
)

Helper method used to directly write a boolean parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to write the value to.
[out]aValueValue written to the parameter.
Returns
Includes:

◆ SetEnumValue() [1/2]

PvResult PvGenParameterArray::SetEnumValue ( const PvString aName,
const PvString aValue 
)

Helper method used to directly write an enumeration parameter value (as a string) of this parameter array.

Parameters
[in]aNameName of the parameter to write the value to.
[out]aValueValue written to the parameter.
Returns
Includes:

◆ SetEnumValue() [2/2]

PvResult PvGenParameterArray::SetEnumValue ( const PvString aName,
int64_t  aValue 
)

Helper method used to directly write an enumeration parameter value (as an integer) of this parameter array.

Parameters
[in]aNameName of the parameter to write the value to.
[out]aValueValue written to the parameter.
Returns
Includes:

◆ SetFloatValue()

PvResult PvGenParameterArray::SetFloatValue ( const PvString aName,
double  aValue 
)

Helper method used to directly write a float parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to write the value to.
[out]aValueValue written to the parameter.
Returns
Includes:

◆ SetIntegerValue()

PvResult PvGenParameterArray::SetIntegerValue ( const PvString aName,
int64_t  aValue 
)

Helper method used to directly write an integer parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to write the value to.
[out]aValueValue written to the parameter.
Returns
Includes:

◆ SetStringValue()

PvResult PvGenParameterArray::SetStringValue ( const PvString aName,
const PvString aValue 
)

Helper method used to directly write a string parameter value of this parameter array.

Parameters
[in]aNameName of the parameter to write the value to.
[out]aValueValue written to the parameter.
Returns
Includes:

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

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