Class PvGenCategory

GenICam category.

Inheritance

object

PvGenCategory

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class PvGenCategory : IDisposable

Remarks

To use this class, see PvGenParameter. In group GenICam features.

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

Implemented

Gets whether the category is implemented.

Declaration

public bool Implemented { get; }

Property Value

Type	Description
bool

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvGenCategory()

Destructor.

Declaration

protected ~PvGenCategory()

GetDescription(out string)

Get the category's description.

Declaration

public PvResult GetDescription(out string aDescription)

Parameters

Type	Name	Description
string	aDescription	The category's description.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

See Also

GetToolTip(out string)

GetDisplayName(out string)

Get the category's display name.

Declaration

public PvResult GetDisplayName(out string aDisplayName)

Parameters

Type	Name	Description
string	aDisplayName	The category's display name; a name that can be used to identify a category in a user-interface context instead of #GetName.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

See Also

GetToolTip(out string)

GetName(out string)

Get the category's name.

Declaration

public PvResult GetName(out string aName)

Parameters

Type	Name	Description
string	aName	The category's name.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

GetNameSpace(ref PvGenNameSpace)

Get the category's name space.

Declaration

public PvResult GetNameSpace(ref PvGenNameSpace aNameSpace)

Parameters

Type	Name	Description
PvGenNameSpace	aNameSpace	The category's name space.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

See Also

GetToolTip(out string)

GetNode()

Returns the GenApi node wrapped by this PvGenCategory

Declaration

public SWIGTYPE_p_PV_GENAPI_NS__INode GetNode()

Returns

Type	Description
SWIGTYPE_p_PV_GENAPI_NS__INode	GenApi node wrapped by this PvGenCategory

GetToolTip(out string)

Get the category's tool tip.

Declaration

public PvResult GetToolTip(out string aToolTip)

Parameters

Type	Name	Description
string	aToolTip	The category's tool tip.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

GetVisibility(ref PvGenVisibility)

Get the category's recommended user level (visibility)

Declaration

public PvResult GetVisibility(ref PvGenVisibility aVisibility)

Parameters

Type	Name	Description
PvGenVisibility	aVisibility	The category's recommended user level; a #PvGenVisibility enumeration.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

See Also

IsVisible(PvGenVisibility, out bool)

IsImplemented(out bool)

Test if the category is implemented.

Declaration

public PvResult IsImplemented(out bool aImplemented)

Parameters

Type	Name	Description
bool	aImplemented	True if the category is implemented; otherwise, false.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

IsVisible(PvGenVisibility)

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

Declaration

public bool IsVisible(PvGenVisibility aCurrentVisibility)

Parameters

Type	Name	Description
PvGenVisibility	aCurrentVisibility	The current visibility setting.

Returns

Type	Description
bool	True if the category is visible at the specified visibilty level.

IsVisible(PvGenVisibility, out bool)

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

Declaration

public PvResult IsVisible(PvGenVisibility aCurrentVisibility, out bool aVisible)

Parameters

Type	Name	Description
PvGenVisibility	aCurrentVisibility	The current visibility setting; a #PvGenVisibility parameter.
bool	aVisible	True if the category is visible; otherwise, false.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::GENERIC_ERROR (Use PvResult::GetDescription to get more information.)

See Also

GetVisibility(ref PvGenVisibility)

Implements

IDisposable