Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenParameter Class Reference

Base class for all GenICam feature types. More...

Public Member Functions

PvString GetName () const
 Get the parameter's name. More...
 
PvResult GetName (PvString &aName) const
 Get the parameter's name. More...
 
PvResult GetType (PvGenType &aType) const
 Get the parameter's type. More...
 
PvResult GetCategory (PvString &aCategory) const
 Get the parameter's category. More...
 
PvResult GetToolTip (PvString &aToolTip) const
 Get the parameter's tool tip. More...
 
PvResult GetDescription (PvString &aDescription) const
 Get the parameter's description. More...
 
PvResult GetDisplayName (PvString &aDisplayName) const
 Get the parameter's display name. More...
 
PvResult GetNameSpace (PvGenNameSpace &aNameSpace) const
 Get the parameter's name space. More...
 
PvResult IsValueCached (bool &aCached) const
 Test if the parameter's value is cached in the PC. More...
 
PvResult IsPersistent (bool &aPersistent) const
 Test if the parameter is to be considered when saving the state of a GenICam interface to disk. More...
 
PvResult IsImplemented (bool &aImplemented) const
 Test if the parameter is implemented. More...
 
PvResult IsAvailable (bool &aAvailable) const
 Test if the parameter is currently available, but may be available latter on. More...
 
PvResult IsWritable (bool &aWritable) const
 Test if the parameter is writable. More...
 
PvResult IsReadable (bool &aReadable) const
 Test if the parameter is readable. More...
 
PvResult IsStreamable (bool &aStreamable) const
 Test if the parameter is streamable. More...
 
bool IsValueCached () const
 Test if the parameter's value is cached in the PC. More...
 
bool IsPersistent () const
 Test if the parameter is to be considered when saving the state of a GenICam interface to disk. More...
 
bool IsImplemented () const
 Test if the parameter is implemented. More...
 
bool IsAvailable () const
 Test if the parameter is currently available, but may be available latter on. More...
 
bool IsWritable () const
 Test if the parameter is writable. More...
 
bool IsReadable () const
 Test if the parameter is readable. More...
 
bool IsVisible (PvGenVisibility aCurrentVisibility) const
 Test if the parameter is visible at the specified visibilty level. More...
 
bool IsStreamable () const
 Test if the parameter is streamable. More...
 
PvResult GetVisibility (PvGenVisibility &aVisibility) const
 Get the parameter's recommended user level (visibility) More...
 
PvResult IsVisible (PvGenVisibility aCurrentVisibility, bool &aVisible) const
 Test if the parameter is visible at the specified visibilty level. More...
 
PvResult IsSelector (bool &aSelector) const
 Queries whether this parameter is a selector or not. More...
 
PvResult GetSelectedParameters (PvGenParameterList &aList) const
 Returns all parameters selected by this parameter. More...
 
PvResult GetSelectingParameters (PvGenParameterList &aList) const
 Returns all selectors for this parameter. More...
 
PvResult RegisterEventSink (PvGenEventSink *aEventSink)
 Register an event sink interface that will be used for callbacks on this parameter. More...
 
PvResult UnregisterEventSink (PvGenEventSink *aEventSink)
 Unregister an event sink. More...
 
PvString ToString () const
 Gets the parameter value as a string. More...
 
PvResult ToString (PvString &aValue) const
 Gets the parameter value as a string. More...
 
PvResult FromString (const PvString &aValue)
 Sets the parameter value from a string. More...
 
GenApi_3_3 ::INode * GetNode ()
 Returns the GenApi node wrapped by this PvGenParameter. More...
 
bool GetUpdatesEnabled ()
 Returns true if parameter update notifications are temporarily disabled. More...
 
void SetUpdatesEnabled (bool aEnabled)
 Temporarily disable (or re-enable) parameter update notifications. More...
 

Protected Member Functions

 PvGenParameter ()
 Constructor.
 
virtual ~PvGenParameter ()
 Destructor.
 

Detailed Description

Base class for all GenICam feature types.

Member Function Documentation

◆ FromString()

PvResult PvGenParameter::FromString ( const PvString aValue)

Sets the parameter value from a string.

Parameters
[in]aValueA string representing the new value to set the parameter to.

Typically used for UI, persistence.

Returns
Includes:

◆ GetCategory()

PvResult PvGenParameter::GetCategory ( PvString aCategory) const

Get the parameter's category.

Parameters
[out]aCategoryThe parameter's category. Levels are separated by '\' characters.
Returns
Includes:

◆ GetDescription()

PvResult PvGenParameter::GetDescription ( PvString aDescription) const

Get the parameter's description.

Parameters
[out]aDescriptionThe parameter's description; typically a long description of what the parameter is.
Returns
Includes:
See also
GetToolTip

◆ GetDisplayName()

PvResult PvGenParameter::GetDisplayName ( PvString aDisplayName) const

Get the parameter's display name.

Parameters
[out]aDisplayNameThe parameter's display name; a name that can be used to identify a parameter in a user-interface context instead of GetName.
Returns
Includes:
See also
GetToolTip

◆ GetName() [1/2]

PvString PvGenParameter::GetName ( ) const

Get the parameter's name.

Returns
The parameter's name.

◆ GetName() [2/2]

PvResult PvGenParameter::GetName ( PvString aName) const

Get the parameter's name.

Parameters
[out]aNameThe parameter's name.
Returns
See GetCategory.

◆ GetNameSpace()

PvResult PvGenParameter::GetNameSpace ( PvGenNameSpace &  aNameSpace) const

Get the parameter's name space.

Parameters
[out]aNameSpaceThe parameter's name space.
Returns
Includes:
See also
GetToolTip

◆ GetNode()

PV_GENAPI_NS::INode * PvGenParameter::GetNode ( )

Returns the GenApi node wrapped by this PvGenParameter.

Returns
GenApi node wrapped by this PvGenPArameter

For advanced use only.

GenApi headers and link libraries are not provided with the eBUS SDK. In order to use the GenApi node provided by this method, install the GenApi SDK.

◆ GetSelectedParameters()

PvResult PvGenParameter::GetSelectedParameters ( PvGenParameterList aList) const

Returns all parameters selected by this parameter.

The list used to output parameters is cleared by this method.

Parameters
[out]aListList (output) where this method copies selected parameter pointers.
Returns
Includes:

◆ GetSelectingParameters()

PvResult PvGenParameter::GetSelectingParameters ( PvGenParameterList aList) const

Returns all selectors for this parameter.

The list used to output parameters is cleared by this method.

Parameters
[out]aListList (output) where this method copies selector parameter pointers.
Returns
Includes:

◆ GetToolTip()

PvResult PvGenParameter::GetToolTip ( PvString aToolTip) const

Get the parameter's tool tip.

Parameters
aToolTipThe parameter's tool tip; typically a brief description of how to use the parameter.
Returns
Includes:

◆ GetType()

PvResult PvGenParameter::GetType ( PvGenType aType) const

Get the parameter's type.

Parameters
[out]aTypeThe parameter's type; a PvGenType enumeration.
Returns
Includes:

◆ GetUpdatesEnabled()

bool PvGenParameter::GetUpdatesEnabled ( )

Returns true if parameter update notifications are temporarily disabled.

Returns
True if they are disabled, false if not.

◆ GetVisibility()

PvResult PvGenParameter::GetVisibility ( PvGenVisibility aVisibility) const

Get the parameter's recommended user level (visibility)

See PvGenVisibility.

Parameters
[out]aVisibilityThe parameter's recommended user level; a PvGenVisibility enumeration.
Returns
Includes:
See also
IsVisible

◆ IsAvailable() [1/2]

bool PvGenParameter::IsAvailable ( ) const

Test if the parameter is currently available, but may be available latter on.

Returns
True if the parameter is currently available; otherwise, false.

◆ IsAvailable() [2/2]

PvResult PvGenParameter::IsAvailable ( bool &  aAvailable) const

Test if the parameter is currently available, but may be available latter on.

Parameters
[out]aAvailableTrue if the parameter is currently available; otherwise, false.
Returns
Includes:

◆ IsImplemented() [1/2]

bool PvGenParameter::IsImplemented ( ) const

Test if the parameter is implemented.

Typically the IsImplemented attribute does not change during the lifetime of a parameter. However some GenICam interfaces are using using IsImplemented in order to activate hidden or advanced features.

Returns
True if the parameter is currently implemented; otherwise, false.

◆ IsImplemented() [2/2]

PvResult PvGenParameter::IsImplemented ( bool &  aImplemented) const

Test if the parameter is implemented.

Typically the IsImplemented attribute does not change during the lifetime of a parameter. However some GenICam interfaces are using IsImplemented in order to activate hidden or advanced features.

Parameters
[out]aImplementedTrue if the parameter is implemented; otherwise, false.
Returns
Includes:

◆ IsPersistent() [1/2]

bool PvGenParameter::IsPersistent ( ) const

Test if the parameter is to be considered when saving the state of a GenICam interface to disk.

Returns
True if the parameter's value is persistent; otherwise, false.

◆ IsPersistent() [2/2]

PvResult PvGenParameter::IsPersistent ( bool &  aPersistent) const

Test if the parameter is to be considered when saving the state of a GenICam interface to disk.

The IsPersistent tests if the feature's persistence attribute is true.

Features that might not be persistent:

  • Features such as a clock's current value and others that are meaningless shortly after the value is retrieved.
  • Some network configuration settings.
  • Etc.
Parameters
[out]aPersistentTrue if the parameter's value is persistent; otherwise, false.
Returns
Includes:

◆ IsReadable() [1/2]

bool PvGenParameter::IsReadable ( ) const

Test if the parameter is readable.

'Readable' is an attribute in the GenICam specification; in practice most parameters are readable.

Returns
True if the parameter is currently readable; otherwise, false.

◆ IsReadable() [2/2]

PvResult PvGenParameter::IsReadable ( bool &  aReadable) const

Test if the parameter is readable.

'Readable' is an attribute in the GenICam specification; in practice most parameters are readable.

Parameters
[out]aReadableTrue if the parameter is currently readable; otherwise, false.
Returns
Includes:

◆ IsSelector()

PvResult PvGenParameter::IsSelector ( bool &  aSelector) const

Queries whether this parameter is a selector or not.

Parameters
[out]aSelectorTrue if the parameter is a selector. False if not.
Returns
Includes:

◆ IsStreamable() [1/2]

bool PvGenParameter::IsStreamable ( ) const

Test if the parameter is streamable.

'Streamable' is an attribute in the GenICam specification; If true, it means the parameter should be considered for persistence.

Returns
True if the parameter to be considered for persistence; otherwise, false.

◆ IsStreamable() [2/2]

PvResult PvGenParameter::IsStreamable ( bool &  aStreamable) const

Test if the parameter is streamable.

'Streamable' is an attribute in the GenICam specification; If true, it means the parameter should be considered for persistence.

Parameters
[out]aStreamableTrue if the parameter to be considered for persistence; otherwise, false.
Returns
Includes:

◆ IsValueCached() [1/2]

bool PvGenParameter::IsValueCached ( ) const

Test if the parameter's value is cached in the PC.

Returns
Includes: True if the PC keeps a cached version of the parameter's value; false if the value must be retrieved from the video interface each time it's requested.

◆ IsValueCached() [2/2]

PvResult PvGenParameter::IsValueCached ( bool &  aCached) const

Test if the parameter's value is cached in the PC.

Parameters
[out]aCachedTrue if the PC keeps a cached version of the parameter's value; false if the value must be retrieved from the video interface each time it's requested.
Returns
Includes:

◆ IsVisible() [1/2]

bool PvGenParameter::IsVisible ( PvGenVisibility  aCurrentVisibility) const

Test if the parameter is visible at the specified visibilty level.

Parameters
[in]aCurrentVisibility
Returns
True if the parameter is visible at the specified visibilty level.

◆ IsVisible() [2/2]

PvResult PvGenParameter::IsVisible ( PvGenVisibility  aCurrentVisibility,
bool &  aVisible 
) const

Test if the parameter is visible at the specified visibilty level.

See PvGenVisibility.

Parameters
[in]aCurrentVisibilityThe current visibility setting; a PvGenVisibility parameter.
[out]aVisibleTrue if the parameter is visible; otherwise, false.
Returns
Includes:
See also
GetVisibility

◆ IsWritable() [1/2]

bool PvGenParameter::IsWritable ( ) const

Test if the parameter is writable.

Returns
True if the parameter is currently writable; otherwise, false.

◆ IsWritable() [2/2]

PvResult PvGenParameter::IsWritable ( bool &  aWritable) const

Test if the parameter is writable.

Parameters
[out]aWritableTrue if the parameter is currently writable; otherwise, false.
Returns
Includes:

◆ RegisterEventSink()

PvResult PvGenParameter::RegisterEventSink ( PvGenEventSink aEventSink)

Register an event sink interface that will be used for callbacks on this parameter.

Event sinks are automatically unregistered when the PvGenParameter object is destroyed (even if UnregisterEventSink wasn't called).

Parameters
[in]aEventSinkThe event sink.
Returns
Includes:

◆ SetUpdatesEnabled()

void PvGenParameter::SetUpdatesEnabled ( bool  aEnabled)

Temporarily disable (or re-enable) parameter update notifications.

Parameters
[in]aEnabledFalse to disable, true to re-enable.

◆ ToString() [1/2]

PvString PvGenParameter::ToString ( ) const

Gets the parameter value as a string.

Returns
Parameter value as a string.

◆ ToString() [2/2]

PvResult PvGenParameter::ToString ( PvString aValue) const

Gets the parameter value as a string.

Parameters
[out]aValueA string representing the parameter value.

Typically used for UI, persistence.

Returns
Includes:

◆ UnregisterEventSink()

PvResult PvGenParameter::UnregisterEventSink ( PvGenEventSink aEventSink)

Unregister an event sink.

Parameters
[in]aEventSinkSee RegisterEventSink
Returns
Includes:

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

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