Class IPvGenApiFactory

GenApi factory used to add custom GenApi parameters to a software-based GigE Vision Device GenICam XML file.

Inheritance

object

IPvGenApiFactory

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetEdge

Assembly: eBUSDotNetEdge.dll

Syntax

public class IPvGenApiFactory : IDisposable

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

AddEnumEntry(string, uint)

Add an enumeration entry to the next feature to be added to the GenICam XML file.

Declaration

public virtual void AddEnumEntry(string aName, uint aValue)

Parameters

Type	Name	Description
string	aName	Name of the new enumeration entry.
uint	aValue	Value of the new enumeration entry.

AddEnumEntry(string, uint, string)

Add an enumeration entry to the next feature to be added to the GenICam XML file.

Declaration

public virtual void AddEnumEntry(string aName, uint aValue, string aDisplayName)

Parameters

Type	Name	Description
string	aName	Name of the new enumeration entry.
uint	aValue	Value of the new enumeration entry.
string	aDisplayName	Custom display name for the new enum entry. If an empty string is provided a default display name is generated for the enum entry.

AddEnumEntry(string, uint, string, PvGenNameSpace)

Add an enumeration entry to the next feature to be added to the GenICam XML file.

Declaration

public virtual void AddEnumEntry(string aName, uint aValue, string aDisplayName, PvGenNameSpace aNameSpace)

Parameters

Type	Name	Description
string	aName	Name of the new enumeration entry.
uint	aValue	Value of the new enumeration entry.
string	aDisplayName	Custom display name for the new enum entry. If an empty string is provided a default display name is generated for the enum entry.
PvGenNameSpace	aNameSpace	Namespace for the new enum entry. See #SetNameSpace for more information on GenICam XML namespaces.

AddInvalidator(string)

Add an invalidator to the next feature to be added to the GenICam XML file.

Declaration

public virtual void AddInvalidator(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Name of the feature that is invalidating the new feature.

AddInvalidatorTo(string, string)

Adds a a custom invalidator to a feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult AddInvalidatorTo(string aStandardFeatureName, string aInvalidatorFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to add the invalidator to.
string	aInvalidatorFeatureName	Name of the feature which changes causes aStandardFeatureName to be invalidated.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

AddSelected(string)

Adds a selector to the next feature to be added to the GenICam XML file.

Declaration

public virtual void AddSelected(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Name of the feature that is selecting the new feature.

AddSelectedTo(string, string)

Adds a custom pSelected entry to a selector feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult AddSelectedTo(string aSelectorFeatureName, string aSelectedFeatureName)

Parameters

Type	Name	Description
string	aSelectorFeatureName	Name of the selector feature to add the pSelected entry to.
string	aSelectedFeatureName	Name of the feature which is selected by aSelectorFeatureName.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

AddVariable(string)

Adds a variable that will be declared for the next SwissKnife of Converter to be added to the GenICam XML file.

Declaration

public virtual void AddVariable(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Feature name to use as variable.

CreateBoolean()

Adds a Boolean feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateBoolean()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateBoolean(IPvRegister)

Adds a Boolean feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateBoolean(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new Boolean feature maps to or nullptr if creating a chunk or messaging channel event data feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateCommand()

Adds a command feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateCommand()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and pValue has not been defined. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateCommand(IPvRegister)

Adds a command feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateCommand(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new command feature maps to.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and pValue has not been defined. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateEnum()

Adds an enumeration feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateEnum()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. If no enumeration entries have been defined for the new feature. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateEnum(IPvRegister)

Adds an enumeration feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateEnum(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new enumeration feature maps to or nullptr if creating a chunk or messaging channel event data feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. If no enumeration entries have been defined for the new feature. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateFloat()

Adds a float feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateFloat()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_INITIALIZED

CreateFloat(IPvRegister)

Adds a float feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateFloat(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new float feature maps to or nullptr if creating a chunk or messaging channel event data feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_INITIALIZED

CreateFloat(IPvRegister, double, double)

Adds a float feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateFloat(IPvRegister aRegister, double aMin, double aMax)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new float feature maps to or nullptr if creating a chunk or messaging channel event data feature.
double	aMin	Minimum of the new float feature.
double	aMax	Maximum of the new float feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. If aMin and aMax are not compatible with each other. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateFloatConverter(string, string, string)

Adds a float Converter to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateFloatConverter(string aValueFeatureName, string aFromFormula, string aToFormula)

Parameters

Type	Name	Description
string	aValueFeatureName	Main feature the converter operates on, referred as TO and FROM in the formulas.
string	aFromFormula	Formula used when reading from the converter.
string	aToFormula	Formula used when writing to the converter.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if value feature name or either formula is empty. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateFloatSwissKnife(string)

Adds a float SwissKnife to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateFloatSwissKnife(string aFormula)

Parameters

Type	Name	Description
string	aFormula	SwissKnife formula.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if the formula is empty. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateIntConverter(string, string, string)

Adds an integer Converter to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateIntConverter(string aValueFeatureName, string aFromFormula, string aToFormula)

Parameters

Type	Name	Description
string	aValueFeatureName	Main feature the converter operates on, referred as TO and FROM in the formulas.
string	aFromFormula	Formula used when reading from the converter.
string	aToFormula	Formula used when writing to the converter.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if value feature name or either formula is empty. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateIntSwissKnife(string)

Adds an integer SwissKnife to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateIntSwissKnife(string aFormula)

Parameters

Type	Name	Description
string	aFormula	SwissKnife formula.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if the formula is empty. #PvResult::Code::NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateInteger()

Adds an integer feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateInteger()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_INITIALIZED

CreateInteger(IPvRegister)

Adds an integer feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateInteger(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new integer feature maps to or nullptr if creating a chunk or messaging channel event data feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_INITIALIZED

CreateInteger(IPvRegister, long, long)

Adds an integer feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateInteger(IPvRegister aRegister, long aMin, long aMax)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new integer feature maps to or nullptr if creating a chunk or messaging channel event data feature.
long	aMin	Minimum of the new integer feature.
long	aMax	Maximum of the new integer feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. If aMin and aMax are not compatible with each other. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateInteger(IPvRegister, long, long, long)

Adds an integer feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateInteger(IPvRegister aRegister, long aMin, long aMax, long aInc)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new integer feature maps to or nullptr if creating a chunk or messaging channel event data feature.
long	aMin	Minimum of the new integer feature.
long	aMax	Maximum of the new integer feature.
long	aInc	Increment of the new integer feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. If aMin and aMax are not compatible with each other. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateRegister()

Adds a register feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateRegister()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateRegister(IPvRegister)

Adds a register feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateRegister(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new register feature maps to or nullptr if creating a chunk or messaging channel event data feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateString()

Adds a string feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateString()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateString(IPvRegister)

Adds a string feature to the GenICam XML file using the current state of the factory for its attributes.

Declaration

public virtual PvResult CreateString(IPvRegister aRegister)

Parameters

Type	Name	Description
IPvRegister	aRegister	Register that the new string feature maps to or nullptr if creating a chunk or messaging channel event data feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER If aRegister is nullptr and none of chunk ID, messaging channel event or pValue has been defined. #PvResult::Code::NOT_INITIALIZED if #SetName has not been called for the new feature.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvGenApiFactory()

Destructor.

Declaration

protected ~IPvGenApiFactory()

MapChunk(uint, uint, uint)

Maps the next feature to be added to the GenICam XML file to a chunk, identified by its ID.

Declaration

public virtual void MapChunk(uint aChunkID, uint aAddress, uint aLength)

Parameters

Type	Name	Description
uint	aChunkID	Chunk ID to map.
uint	aAddress	Data offset of the feature in the chunk, in bytes.
uint	aLength	Data length of the feature in the chunk, in bytes.

MapChunk(uint, uint, uint, PvGenEndianness)

Maps the next feature to be added to the GenICam XML file to a chunk, identified by its ID.

Declaration

public virtual void MapChunk(uint aChunkID, uint aAddress, uint aLength, PvGenEndianness aEndianness)

Parameters

Type	Name	Description
uint	aChunkID	Chunk ID to map.
uint	aAddress	Data offset of the feature in the chunk, in bytes.
uint	aLength	Data length of the feature in the chunk, in bytes.
PvGenEndianness	aEndianness	Data endianness.

MapEvent(uint, uint, uint)

Maps the next feature to be added to the GenICam XML file to a messaging channel event, identified by its ID.

Declaration

public virtual void MapEvent(uint aEventID, uint aAddress, uint aLength)

Parameters

Type	Name	Description
uint	aEventID	Event ID to map.
uint	aAddress	Data offset of the feature in the event data, in bytes.
uint	aLength	Data length of the feature in the event data, in bytes.

MapEvent(uint, uint, uint, PvGenEndianness)

Maps the next feature to be added to the GenICam XML file to a messaging channel event, identified by its ID.

Declaration

public virtual void MapEvent(uint aEventID, uint aAddress, uint aLength, PvGenEndianness aEndianness)

Parameters

Type	Name	Description
uint	aEventID	Event ID to map.
uint	aAddress	Data offset of the feature in the event data, in bytes.
uint	aLength	Data length of the feature in the event data, in bytes.
PvGenEndianness	aEndianness	Data endianness.

MapEvent(uint, uint, uint, PvGenEndianness, bool)

Maps the next feature to be added to the GenICam XML file to a messaging channel event, identified by its ID.

Declaration

public virtual void MapEvent(uint aEventID, uint aAddress, uint aLength, PvGenEndianness aEndianness, bool aAdjustAddress)

Parameters

Type	Name	Description
uint	aEventID	Event ID to map.
uint	aAddress	Data offset of the feature in the event data, in bytes.
uint	aLength	Data length of the feature in the event data, in bytes.
PvGenEndianness	aEndianness	Data endianness.
bool	aAdjustAddress	Applies an offset on the provided address.

SetAccessMode(PvGenAccessMode)

Sets the access mode of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetAccessMode(PvGenAccessMode aAccessMode)

Parameters

Type	Name	Description
PvGenAccessMode	aAccessMode	Feature access mode.

SetCachable(PvGenCache)

Sets the cache behavior of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetCachable(PvGenCache aCache)

Parameters

Type	Name	Description
PvGenCache	aCache	Feature cachable.

SetCategory(string)

Sets the category of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetCategory(string aCategory)

Parameters

Type	Name	Description
string	aCategory	Feature category.

SetCategory(string, string)

Sets the category and display name of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetCategory(string aCategory, string aCategoryDisplayName)

Parameters

Type	Name	Description
string	aCategory	Feature category.
string	aCategoryDisplayName	Feature category display name.

SetDescription(string)

Sets the description of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetDescription(string aDescription)

Parameters

Type	Name	Description
string	aDescription	Feature description.

SetDisplayName(string)

Sets the display name of the next feature to be added to the GenICam XML.

Declaration

public virtual void SetDisplayName(string aDisplayName)

Parameters

Type	Name	Description
string	aDisplayName	Feature name.

SetName(string)

Sets the name of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetName(string aName)

Parameters

Type	Name	Description
string	aName	Feature name.

SetNameSpace(PvGenNameSpace)

Sets the namespace of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetNameSpace(PvGenNameSpace aNameSpace)

Parameters

Type	Name	Description
PvGenNameSpace	aNameSpace	Feature namespace.

SetPInc(string)

Sets node to use for integer dynamic increment attribute.

Declaration

public virtual void SetPInc(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Name of the feature the integer increment attribute points to.

SetPIncFor(string, string)

Forces a pInc reference for an integer feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPIncFor(string aStandardFeatureName, string aPIncFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to force pInc for.
string	aPIncFeatureName	Name of the feature used provide the maximum of the aStandardFeatureName feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPIsAvailable(string)

Sets the pIsAvaialble attribute of the next feature to be added to the GenICam XML.

Declaration

public virtual void SetPIsAvailable(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Feature name to use for pIsImplemented.

SetPIsAvailableFor(string, string)

Forces a pIsAvailable reference for a feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPIsAvailableFor(string aStandardFeatureName, string aPIsAvailableFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to add the pIsAvailable for.
string	aPIsAvailableFeatureName	Feature used to evaluate if the feature is available or not.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPIsAvailableForEnumEntry(string, string, string)

Forces a pIsAvailable reference for a the enum entry of an enum feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPIsAvailableForEnumEntry(string aStandardFeatureName, string aEnumEntryName, string aPIsAvailableFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the enum feature the enum entry belongs to.
string	aEnumEntryName	Name of the enum entry to add the pIsAvailable for.
string	aPIsAvailableFeatureName	Feature used to evaluate if the enum entry is available or not.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPIsLocked(string)

Sets the pIsLocked attribute of the next feature to be added to the GenICam XML.

Declaration

public virtual void SetPIsLocked(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Feature name to use for pIsLocked.

SetPIsLockedFor(string, string)

Forces a pIsLocked reference for a feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPIsLockedFor(string aStandardFeatureName, string aPIsLockedFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to add the pIsLocked for.
string	aPIsLockedFeatureName	Feature used to evaluate if the feature is locked or not.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPMax(string)

Sets node to use for integer or float dynamic maximum attribute.

Declaration

public virtual void SetPMax(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Name of the feature the integer or float maximum attribute points to.

SetPMaxFor(string, string)

Forces a pMax reference for an integer or float feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPMaxFor(string aStandardFeatureName, string aPMaxFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to force pMax for.
string	aPMaxFeatureName	Name of the feature used provide the maximum of the aStandardFeatureName feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPMin(string)

Sets node to use for integer or float dynamic minimum attribute.

Declaration

public virtual void SetPMin(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Name of the feature the integer or float minimum attribute points to.

SetPMinFor(string, string)

Forces a pMin reference for an integer or float feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPMinFor(string aStandardFeatureName, string aPMinFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to force pMin for.
string	aPMinFeatureName	Name of the feature used provide the minimum of the aStandardFeatureName feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPValue(string)

Sets the pValue attribute of the next feature to be added to the GenICam XML.

Declaration

public virtual void SetPValue(string aFeatureName)

Parameters

Type	Name	Description
string	aFeatureName	Feature name to use for pValue.

SetPValueFor(string, string)

Forces a pValue reference for a feature managed by #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetPValueFor(string aStandardFeatureName, string aPValueFeatureName)

Parameters

Type	Name	Description
string	aStandardFeatureName	Name of the feature to force pValue for.
string	aPValueFeatureName	Name of the feature used provide the value of the aStandardFeatureName feature.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success.

SetPollingTime(uint)

Sets the polling time, in ms, of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetPollingTime(uint aPollingTime)

Parameters

Type	Name	Description
uint	aPollingTime	Feature polling time.

SetRepresentation(PvGenRepresentation)

Sets the numeric representation of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetRepresentation(PvGenRepresentation aRepresentation)

Parameters

Type	Name	Description
PvGenRepresentation	aRepresentation	Feature representation.

SetStreamable(bool)

Sets the streamable behaviour of the next feature to be added to the GenICam XML.

Declaration

public virtual void SetStreamable(bool aStreamable)

Parameters

Type	Name	Description
bool	aStreamable	Feature streamable attribute.

SetTLLocked(bool)

Sets the TLParamsLocked behavior of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetTLLocked(bool aLocked)

Parameters

Type	Name	Description
bool	aLocked	Feature TLLocked attribute.

SetToolTip(string)

Sets the tooltip of the next feature to be added to the GenICam XML file.

Declaration

public virtual void SetToolTip(string aToolTip)

Parameters

Type	Name	Description
string	aToolTip	Feature tooltip.

SetUnit(string)

Sets the units for an integer or float feature.

Declaration

public virtual void SetUnit(string aUnit)

Parameters

Type	Name	Description
string	aUnit	Feature unit attribute.

SetVisibility(PvGenVisibility)

Sets the visibility of the next feature to be added to the GenICam XML.

Declaration

public virtual void SetVisibility(PvGenVisibility aVisibility)

Parameters

Type	Name	Description
PvGenVisibility	aVisibility	Feature visibility.

Implements

IDisposable