Class PvGenParameter

Base class for all GenICam feature types.

Inheritance

object

PvGenParameter

PvGenBoolean

PvGenCommand

PvGenEnum

PvGenFloat

PvGenInteger

PvGenRegister

PvGenString

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

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 parameter is currently available.

Declaration

public bool Available { get; }

Property Value

Type	Description
bool

Implemented

Gets whether the parameter is implemented.

Declaration

public bool Implemented { get; }

Property Value

Type	Description
bool

Name

Gets the parameter name.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Persistent

Gets whether the parameter is persistent.

Declaration

public bool Persistent { get; }

Property Value

Type	Description
bool

Readable

Gets whether the parameter is readable.

Declaration

public bool Readable { get; }

Property Value

Type	Description
bool

Streamable

Gets whether the parameter is streamable.

Declaration

public bool Streamable { get; }

Property Value

Type	Description
bool

UpdatesEnabled

Gets or sets whether parameter updates are enabled.

Declaration

public bool UpdatesEnabled { get; set; }

Property Value

Type	Description
bool

ValueCached

Gets whether the parameter value is cached.

Declaration

public bool ValueCached { get; }

Property Value

Type	Description
bool

Writable

Gets whether the parameter is writable.

Declaration

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

~PvGenParameter()

Destructor.

Declaration

protected ~PvGenParameter()

FromString(string)

Sets the parameter value from a string.

Declaration

public PvResult FromString(string aValue)

Parameters

Type	Name	Description
string	aValue	A string representing the new value to set the parameter to.

Returns

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

GetCategory(out string)

Get the parameter's category.

Declaration

public PvResult GetCategory(out string aCategory)

Parameters

Type	Name	Description
string	aCategory	The parameter's category. Levels are separated by '' characters.

Returns

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

GetDescription(out string)

Get the parameter's description.

Declaration

public PvResult GetDescription(out string aDescription)

Parameters

Type	Name	Description
string	aDescription	The parameter's description; typically a long description of what the parameter is.

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 parameter's display name.

Declaration

public PvResult GetDisplayName(out string aDisplayName)

Parameters

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

Declaration

public PvResult GetName(out string aName)

Parameters

Type	Name	Description
string	aName	The parameter's name.

Returns

Type	Description
PvResult	See #GetCategory.

GetNameSpace(ref PvGenNameSpace)

Get the parameter's name space.

Declaration

public PvResult GetNameSpace(ref PvGenNameSpace aNameSpace)

Parameters

Type	Name	Description
PvGenNameSpace	aNameSpace	The parameter'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 PvGenParameter

Declaration

public SWIGTYPE_p_PV_GENAPI_NS__INode GetNode()

Returns

Type	Description
SWIGTYPE_p_PV_GENAPI_NS__INode	GenApi node wrapped by this PvGenPArameter

GetSelectedParameters(ref PvGenParameterList)

Returns all parameters selected by this parameter.

Declaration

public PvResult GetSelectedParameters(ref PvGenParameterList aList)

Parameters

Type	Name	Description
PvGenParameterList	aList	List (output) where this method copies selected parameter pointers.

Returns

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

GetSelectingParameters(ref PvGenParameterList)

Returns all selectors for this parameter.

Declaration

public PvResult GetSelectingParameters(ref PvGenParameterList aList)

Parameters

Type	Name	Description
PvGenParameterList	aList	List (output) where this method copies selector parameter pointers.

Returns

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

GetToolTip(out string)

Get the parameter's tool tip.

Declaration

public PvResult GetToolTip(out string aToolTip)

Parameters

Type	Name	Description
string	aToolTip	The parameter's tool tip; typically a brief description of how to use the parameter.

Returns

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

GetType(ref PvGenType)

Get the parameter's type.

Declaration

public PvResult GetType(ref PvGenType aType)

Parameters

Type	Name	Description
PvGenType	aType	The parameter's type; a PvGenType enumeration.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK

GetVisibility(ref PvGenVisibility)

Get the parameter's recommended user level (visibility)

Declaration

public PvResult GetVisibility(ref PvGenVisibility aVisibility)

Parameters

Type	Name	Description
PvGenVisibility	aVisibility	The parameter'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)

IsAvailable(out bool)

Test if the parameter is currently available, but may be available latter on.

Declaration

public PvResult IsAvailable(out bool aAvailable)

Parameters

Type	Name	Description
bool	aAvailable	True if the parameter is currently available; otherwise, false.

Returns

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

IsImplemented(out bool)

Test if the parameter is implemented.

Declaration

public PvResult IsImplemented(out bool aImplemented)

Parameters

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

Returns

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

IsPersistent(out bool)

Test if the parameter is to be considered when saving the state of a GenICam interface to disk.

Declaration

public PvResult IsPersistent(out bool aPersistent)

Parameters

Type	Name	Description
bool	aPersistent	True if the parameter's value is persistent; otherwise, false.

Returns

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

IsReadable(out bool)

Test if the parameter is readable.

Declaration

public PvResult IsReadable(out bool aReadable)

Parameters

Type	Name	Description
bool	aReadable	True if the parameter is currently readable; otherwise, false.

Returns

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

IsSelector(out bool)

Queries whether this parameter is a selector or not.

Declaration

public PvResult IsSelector(out bool aSelector)

Parameters

Type	Name	Description
bool	aSelector	True if the parameter is a selector. False if not.

Returns

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

IsStreamable(out bool)

Test if the parameter is streamable.

Declaration

public PvResult IsStreamable(out bool aStreamable)

Parameters

Type	Name	Description
bool	aStreamable	True if the parameter to be considered for persistence; otherwise, false.

Returns

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

IsValueCached(out bool)

Test if the parameter's value is cached in the PC.

Declaration

public PvResult IsValueCached(out bool aCached)

Parameters

Type	Name	Description
bool	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.

Returns

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

IsVisible(PvGenVisibility)

Test if the parameter 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 parameter is visible at the specified visibilty level.

IsVisible(PvGenVisibility, out bool)

Test if the parameter 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 parameter 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)

IsWritable(out bool)

Test if the parameter is writable.

Declaration

public PvResult IsWritable(out bool aWritable)

Parameters

Type	Name	Description
bool	aWritable	True if the parameter is currently writable; otherwise, false.

Returns

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

RegisterEventSink(PvGenEventSinkSwigInterface)

Register an event sink interface that will be used for callbacks on this parameter.

Declaration

public PvResult RegisterEventSink(PvGenEventSinkSwigInterface aEventSink)

Parameters

Type	Name	Description
PvGenEventSinkSwigInterface	aEventSink	The event sink.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER #PvResult::Code::GENERIC_ERROR

UnregisterEventSink(PvGenEventSinkSwigInterface)

Unregister an event sink.

Declaration

public PvResult UnregisterEventSink(PvGenEventSinkSwigInterface aEventSink)

Parameters

Type	Name	Description
PvGenEventSinkSwigInterface	aEventSink	See #RegisterEventSink

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::NOT_FOUND #PvResult::Code::INVALID_PARAMETER

ValueToString()

Gets the parameter value as a string.

Declaration

public string ValueToString()

Returns

Type	Description
string	Parameter value as a string.

ValueToString(out string)

Gets the parameter value as a string.

Declaration

public PvResult ValueToString(out string aValue)

Parameters

Type	Name	Description
string	aValue	A string representing the parameter value.

Returns

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

Events

OnParameterUpdate

Event raised when the parameter value is updated.

Declaration

public event OnParameterUpdateHandler OnParameterUpdate

Event Type

Type	Description
OnParameterUpdateHandler

Implements

IDisposable