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. | |
Base class for all GenICam feature types.
Sets the parameter value from a string.
[in] | aValue | A string representing the new value to set the parameter to. |
Typically used for UI, persistence.
Get the parameter's category.
[out] | aCategory | The parameter's category. Levels are separated by '\' characters. |
Get the parameter's description.
[out] | aDescription | The parameter's description; typically a long description of what the parameter is. |
Get the parameter's display name.
[out] | aDisplayName | The parameter's display name; a name that can be used to identify a parameter in a user-interface context instead of GetName. |
PvString PvGenParameter::GetName | ( | ) | const |
Get the parameter's name.
PvResult PvGenParameter::GetNameSpace | ( | PvGenNameSpace & | aNameSpace | ) | const |
Get the parameter's name space.
[out] | aNameSpace | The parameter's name space. |
PV_GENAPI_NS::INode * PvGenParameter::GetNode | ( | ) |
Returns the 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.
PvResult PvGenParameter::GetSelectedParameters | ( | PvGenParameterList & | aList | ) | const |
Returns all parameters selected by this parameter.
The list used to output parameters is cleared by this method.
[out] | aList | List (output) where this method copies selected parameter pointers. |
PvResult PvGenParameter::GetSelectingParameters | ( | PvGenParameterList & | aList | ) | const |
Returns all selectors for this parameter.
The list used to output parameters is cleared by this method.
[out] | aList | List (output) where this method copies selector parameter pointers. |
Get the parameter's tool tip.
aToolTip | The parameter's tool tip; typically a brief description of how to use the parameter. |
Get the parameter's type.
[out] | aType | The parameter's type; a PvGenType enumeration. |
bool PvGenParameter::GetUpdatesEnabled | ( | ) |
Returns true if parameter update notifications are temporarily disabled.
PvResult PvGenParameter::GetVisibility | ( | PvGenVisibility & | aVisibility | ) | const |
Get the parameter's recommended user level (visibility)
See PvGenVisibility.
[out] | aVisibility | The parameter's recommended user level; a PvGenVisibility enumeration. |
PvResult PvGenParameter::IsAvailable | ( | bool & | aAvailable | ) | const |
Test if the parameter is currently available, but may be available latter on.
[out] | aAvailable | True if the parameter is currently available; otherwise, false. |
bool PvGenParameter::IsAvailable | ( | ) | const |
Test if the parameter is currently available, but may be available latter on.
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.
[out] | aImplemented | True if the parameter is implemented; otherwise, false. |
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.
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:
[out] | aPersistent | True if the parameter's value is persistent; otherwise, false. |
bool PvGenParameter::IsPersistent | ( | ) | const |
Test if the parameter is to be considered when saving the state of a GenICam interface to disk.
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.
[out] | aReadable | True if the parameter is currently readable; otherwise, false. |
bool PvGenParameter::IsReadable | ( | ) | const |
Test if the parameter is readable.
'Readable' is an attribute in the GenICam specification; in practice most parameters are readable.
PvResult PvGenParameter::IsSelector | ( | bool & | aSelector | ) | const |
Queries whether this parameter is a selector or not.
[out] | aSelector | True if the parameter is a selector. False if not. |
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.
[out] | aStreamable | True if the parameter to be considered for persistence; otherwise, false. |
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.
PvResult PvGenParameter::IsValueCached | ( | bool & | aCached | ) | const |
Test if the parameter's value is cached in the PC.
[out] | aCached | 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. |
bool PvGenParameter::IsValueCached | ( | ) | const |
Test if the parameter's value is cached in the PC.
bool PvGenParameter::IsVisible | ( | PvGenVisibility | aCurrentVisibility | ) | const |
Test if the parameter is visible at the specified visibilty level.
[in] | aCurrentVisibility |
PvResult PvGenParameter::IsVisible | ( | PvGenVisibility | aCurrentVisibility, |
bool & | aVisible | ||
) | const |
Test if the parameter is visible at the specified visibilty level.
See PvGenVisibility.
[in] | aCurrentVisibility | The current visibility setting; a PvGenVisibility parameter. |
[out] | aVisible | True if the parameter is visible; otherwise, false. |
PvResult PvGenParameter::IsWritable | ( | bool & | aWritable | ) | const |
Test if the parameter is writable.
[out] | aWritable | True if the parameter is currently writable; otherwise, false. |
bool PvGenParameter::IsWritable | ( | ) | const |
Test if the parameter is writable.
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).
[in] | aEventSink | The event sink. |
void PvGenParameter::SetUpdatesEnabled | ( | bool | aEnabled | ) |
Temporarily disable (or re-enable) parameter update notifications.
[in] | aEnabled | False to disable, true to re-enable. |
PvString PvGenParameter::ToString | ( | ) | const |
Gets the parameter value as a string.
Gets the parameter value as a string.
[out] | aValue | A string representing the parameter value. |
Typically used for UI, persistence.
PvResult PvGenParameter::UnregisterEventSink | ( | PvGenEventSink * | aEventSink | ) |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com