Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenCategory Class Reference

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.
 

Detailed Description

GenICam category.

Member Function Documentation

◆ GetDescription()

PvResult PvGenCategory::GetDescription ( PvString aDescription) const

Get the category's description.

Parameters
[out]aDescriptionThe category's description.
Returns
Includes:
See also
GetToolTip

◆ GetDisplayName()

PvResult PvGenCategory::GetDisplayName ( PvString aDisplayName) const

Get the category's display name.

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

◆ GetName()

PvResult PvGenCategory::GetName ( PvString aName) const

Get the category's name.

Parameters
[out]aNameThe category's name.
Returns
Includes:

◆ GetNameSpace()

PvResult PvGenCategory::GetNameSpace ( PvGenNameSpace &  aNameSpace) const

Get the category's name space.

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

◆ GetNode()

PV_GENAPI_NS::INode * PvGenCategory::GetNode ( )

Returns the GenApi node wrapped by this PvGenCategory.

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

◆ GetToolTip()

PvResult PvGenCategory::GetToolTip ( PvString aToolTip) const

Get the category's tool tip.

Parameters
aToolTipThe category's tool tip.
Returns
Includes:

◆ GetVisibility()

PvResult PvGenCategory::GetVisibility ( PvGenVisibility aVisibility) const

Get the category's recommended user level (visibility)

See PvGenVisibility.

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

◆ IsImplemented() [1/2]

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.

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

◆ IsImplemented() [2/2]

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.

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

◆ IsVisible() [1/2]

bool PvGenCategory::IsVisible ( PvGenVisibility  aCurrentVisibility) const

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

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

◆ IsVisible() [2/2]

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

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

See PvGenVisibility.

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

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

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