Class PvGenEnumEntry

GenICam feature: Enumeration entry

Inheritance

object

PvGenEnumEntry

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 PvGenEnumEntry : IDisposable

Remarks

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

Constructors

PvGenEnumEntry(nint, bool, bool)

Internal constructor for marshaling.

Declaration

public PvGenEnumEntry(nint cPtr, bool cMemoryOwn, bool cInternalOnly = true)

Parameters

Type	Name	Description
nint	cPtr	Pointer to the native object.
bool	cMemoryOwn	Whether the managed object owns the native memory.
bool	cInternalOnly	Indicates this constructor is for internal use only.

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

Available

Gets whether the enum entry is currently available.

Declaration

public bool Available { 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

~PvGenEnumEntry()

Destructor.

Declaration

protected ~PvGenEnumEntry()

GetDescription(out string)

Get a longer description of the enum entry.

Declaration

public PvResult GetDescription(out string aDescription)

Parameters

Type	Name	Description
string	aDescription	A longer description of the enum entry.

Returns

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

GetDisplayName(out string)

Get the enum entry's display name.

Declaration

public PvResult GetDisplayName(out string aDisplayName)

Parameters

Type	Name	Description
string	aDisplayName	The enum entry's display name; a name that can be used to identify an enum entry 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.)

GetName(out string)

Get the enumeration entry's name.

Declaration

public PvResult GetName(out string aName)

Parameters

Type	Name	Description
string	aName	The enumeration entry's name

Returns

Type	Description
PvResult	See #GetDescription.

GetNameSpace(ref PvGenNameSpace)

Get the enum enty's name space.

Declaration

public PvResult GetNameSpace(ref PvGenNameSpace aNameSpace)

Parameters

Type	Name	Description
PvGenNameSpace	aNameSpace	The enum entry's name space.

Returns

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

GetToolTip(out string)

Get a short description of the enum entry.

Declaration

public PvResult GetToolTip(out string aToolTip)

Parameters

Type	Name	Description
string	aToolTip	A short description of the enum entry.

Returns

Type	Description
PvResult	See #GetDescription.

GetValue(out long)

Get the enumeration entry's value.

Declaration

public PvResult GetValue(out long aValue)

Parameters

Type	Name	Description
long	aValue	The enumeration entry's value.

Returns

Type	Description
PvResult	See #GetDescription.

See Also

GetValue(out string)

GetVisibility(ref PvGenVisibility)

Get the enumeration entry's current visibility level.

Declaration

public PvResult GetVisibility(ref PvGenVisibility aVisibility)

Parameters

Type	Name	Description
PvGenVisibility	aVisibility	See PvGenParameter::GetVisibility.

Returns

Type	Description
PvResult	See #GetDescription.

See Also

GetVisibility(ref PvGenVisibility)

IsAvailable(out bool)

Test if the enumeration entry is currently available.

Declaration

public PvResult IsAvailable(out bool aAvailable)

Parameters

Type	Name	Description
bool	aAvailable	See PvGenParameter::IsAvailable.

Returns

Type	Description
PvResult	See #GetDescription.

See Also

IsAvailable(out bool)

IsVisible(PvGenVisibility)

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

Declaration

public bool IsVisible(PvGenVisibility aVisibility)

Parameters

Type	Name	Description
PvGenVisibility	aVisibility	The visibility level to test against.

Returns

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

IsVisible(PvGenVisibility, out bool)

Test if the enumeration entry is above a specific visibilty level.

Declaration

public PvResult IsVisible(PvGenVisibility aVisibility, out bool aVisible)

Parameters

Type	Name	Description
PvGenVisibility	aVisibility	See PvGenParameter::IsVisible.
bool	aVisible	See PvGenParameter::IsVisible.

Returns

Type	Description
PvResult	See #GetDescription.

See Also

IsVisible(PvGenVisibility)

Implements

IDisposable