GenICam category. More...
Public Member Functions | |
PvResult | GetName (PvString &aName) const |
Get the category's name. More... | |
PvResult | GetToolTip (PvString &aToolTip) const |
Get the category's tool tip. More... | |
PvResult | GetDescription (PvString &aDescription) const |
Get the category's description. More... | |
PvResult | GetDisplayName (PvString &aDisplayName) const |
Get the category's display name. More... | |
PvResult | GetNameSpace (PvGenNameSpace &aNameSpace) const |
Get the category's name space. More... | |
PvResult | GetVisibility (PvGenVisibility &aVisibility) const |
Get the category's recommended user level (visibility) More... | |
PvResult | IsVisible (PvGenVisibility aCurrentVisibility, bool &aVisible) const |
Test if the category is visible at the specified visibilty level. More... | |
bool | IsVisible (PvGenVisibility aCurrentVisibility) const |
Test if the category is visible at the specified visibilty level. More... | |
PvResult | IsImplemented (bool &aImplemented) const |
Test if the category is implemented. More... | |
bool | IsImplemented () const |
Test if the category is implemented. More... | |
GenApi_3_3::INode * | GetNode () |
Returns the GenApi node wrapped by this PvGenCategory. More... | |
Protected Member Functions | |
PvGenCategory () | |
Constructor. | |
virtual | ~PvGenCategory () |
Destructor. | |
GenICam category.
Get the category's description.
[out] | aDescription | The category's description. |
Get the category's display name.
[out] | aDisplayName | The category's display name; a name that can be used to identify a category in a user-interface context instead of GetName. |
Get the category's name.
[out] | aName | The category's name. |
PvResult PvGenCategory::GetNameSpace | ( | PvGenNameSpace & | aNameSpace | ) | const |
Get the category's name space.
[out] | aNameSpace | The category's name space. |
PV_GENAPI_NS::INode * PvGenCategory::GetNode | ( | ) |
Returns the GenApi node wrapped by this PvGenCategory.
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.
Get the category's tool tip.
aToolTip | The category's tool tip. |
PvResult PvGenCategory::GetVisibility | ( | PvGenVisibility & | aVisibility | ) | const |
Get the category's recommended user level (visibility)
See PvGenVisibility.
[out] | aVisibility | The category's recommended user level; a PvGenVisibility enumeration. |
PvResult PvGenCategory::IsImplemented | ( | bool & | aImplemented | ) | const |
Test if the category is implemented.
Typically the IsImplemented attribute does not change during the lifetime of a category. However some GenICam interfaces are using using IsImplemented in order to activate hidden or advanced features.
[out] | aImplemented | True if the category is implemented; otherwise, false. |
bool PvGenCategory::IsImplemented | ( | ) | const |
Test if the category is implemented.
Typically the IsImplemented attribute does not change during the lifetime of a category. However some GenICam interfaces are using using IsImplemented in order to activate hidden or advanced features.
PvResult PvGenCategory::IsVisible | ( | PvGenVisibility | aCurrentVisibility, |
bool & | aVisible | ||
) | const |
Test if the category is visible at the specified visibilty level.
See PvGenVisibility.
[in] | aCurrentVisibility | The current visibility setting; a PvGenVisibility parameter. |
[out] | aVisible | True if the category is visible; otherwise, false. |
bool PvGenCategory::IsVisible | ( | PvGenVisibility | aCurrentVisibility | ) | const |
Test if the category is visible at the specified visibilty level.
[in] | aCurrentVisibility |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com