Class IPvDeviceAdapter

Interface used by PvDeviceSerialPort to interact with a device controller.

Inheritance

object

IPvDeviceAdapter

Implements

IPvDeviceAdapterSwigInterface

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class IPvDeviceAdapter : IPvDeviceAdapterSwigInterface, IDisposable

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvDeviceAdapter()

Destructor.

Declaration

protected ~IPvDeviceAdapter()

GetGenBooleanValue(string, out bool)

Returns the value of a Boolean identified by its name.

Declaration

public virtual PvResult GetGenBooleanValue(string aParameterName, out bool aValue)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
bool	aValue	Value of the parameter.

Returns

Type	Description
PvResult	OK on success.

GetGenEnumEntriesAvailable(string, SWIGTYPE_p_PvStringList)

Returns a list of all available enum entries for an enumeration

Declaration

public virtual PvResult GetGenEnumEntriesAvailable(string aParameterName, SWIGTYPE_p_PvStringList aList)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
SWIGTYPE_p_PvStringList	aList	A list containing the string representation of all available enum entries.

Returns

Type	Description
PvResult	OK on success.

GetGenEnumValue(string, out string)

Returns the string value of an enumeration identified by its name.

Declaration

public virtual PvResult GetGenEnumValue(string aParameterName, out string aEnumEntry)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
string	aEnumEntry	Value of the parameter.

Returns

Type	Description
PvResult	OK on success.

GetGenIntegerValue(string, out long)

Returns the value of an integer identified by its name.

Declaration

public virtual PvResult GetGenIntegerValue(string aParameterName, out long aValue)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
long	aValue	Value of the parameter.

Returns

Type	Description
PvResult	OK on success.

GetGenRegisterData(string, byte[], long)

Gets the data contained in a register identified by its name.

Declaration

public PvResult GetGenRegisterData(string aParameterName, byte[] aDataBuffer, long aByteCount)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
byte[]	aDataBuffer	Buffer where to copy the data.
long	aByteCount	How many bytes to copy to aDataBuffer.

Returns

Type	Description
PvResult	OK on success.

GetGenRegisterLength(string, out long)

Gets the length (in bytes) of a register identified by its name.

Declaration

public virtual PvResult GetGenRegisterLength(string aParameterName, out long aLength)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
long	aLength	Length (in bytes) of the register.

Returns

Type	Description
PvResult	OK on success.

GetGenStringValue(string, out string)

Returns the string value of string parameter identified by its name.

Declaration

public virtual PvResult GetGenStringValue(string aParameterName, out string aValue)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
string	aValue	Value of the parameter.

Returns

Type	Description
PvResult	OK on success.

GetUniqueID(out string)

Returns a unique string identifier for the device.

Declaration

public virtual PvResult GetUniqueID(out string aID)

Parameters

Type	Name	Description
string	aID	Unique string identifier for the device.

Returns

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

IsConnected()

Returns true if the device is connected.

Declaration

public virtual bool IsConnected()

Returns

Type	Description
bool	True if the device is connected, false if not.

IsGenBooleanInNodeMap(string)

Returns true if the device node map contains a Boolean of the specified name.

Declaration

public virtual bool IsGenBooleanInNodeMap(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.

Returns

Type	Description
bool	True if the parameter is present, false if not.

IsGenEnumEntryAvailable(string, string)

Returns true if an enumeration is present in the node map and has a specific enum entry.

Declaration

public virtual bool IsGenEnumEntryAvailable(string aParameterName, string aEnumEntry)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.
string	aEnumEntry	Name of the enum entry to test for.

Returns

Type	Description
bool	True if the parameter is present and contains the specific enum entry, false if either condition fails.

IsGenEnumInNodeMap(string)

Returns true if the device node map contains an enumeration of the specified name.

Declaration

public virtual bool IsGenEnumInNodeMap(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.

Returns

Type	Description
bool	True if the parameter is present, false if not.

IsGenIntegerInNodeMap(string)

Returns true if the device node map contains an integer of the specified name.

Declaration

public virtual bool IsGenIntegerInNodeMap(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.

Returns

Type	Description
bool	True if the parameter is present, false if not.

IsGenReadable(string)

Returns true if a parameter is present and readable in the node map.

Declaration

public virtual bool IsGenReadable(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.

Returns

Type	Description
bool	True if the parameter is present and readable, false if either condition fails.

IsGenRegisterInNodeMap(string)

Returns true if the device node map contains a raw register of the specified name.

Declaration

public virtual bool IsGenRegisterInNodeMap(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.

Returns

Type	Description
bool	True if the parameter is present, false if not.

IsGenWritable(string)

Returns true if a parameter is present and writable in the node map.

Declaration

public virtual bool IsGenWritable(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter to test for.

Returns

Type	Description
bool	True if the parameter is present and writable, false if either condition fails.

IsGigEVision()

Returns true if the device uses the GigE Vision protocol.

Declaration

public virtual bool IsGigEVision()

Returns

Type	Description
bool	True if using the GigE Vision protocol, false if not.

IsPleoraPowered()

Returns true if the device runs on a Pleora design.

Declaration

public virtual bool IsPleoraPowered()

Returns

Type	Description
bool	True if the device runs on a Pleora design, false if not.

IsUSB3Vision()

Returns true if the device uses the USB3 Vision protocol.

Declaration

public virtual bool IsUSB3Vision()

Returns

Type	Description
bool	True if using the USB3 Vision protocol, false if not.

ReadMemory(byte[], long, long)

Reads data from the memory of a device.

Declaration

public PvResult ReadMemory(byte[] aBuffer, long aAddress, long aLength)

Parameters

Type	Name	Description
byte[]	aBuffer	Pointer of the buffer where the data will be written.
long	aAddress	Address where to read the data.
long	aLength	Length of the data to read, in bytes.

Returns

Type	Description
PvResult	OK on success.

ReadRegister(long, out uint)

Reads a 32 bit value from a GigE Vision register.

Declaration

public virtual PvResult ReadRegister(long aAddress, out uint aValue)

Parameters

Type	Name	Description
long	aAddress	Address of the register.
uint	aValue	Value read from the register.

Returns

Type	Description
PvResult	OK on success.

RegisterEventSink(SWIGTYPE_p_IPvDeviceEventSink)

Registers an event sink that will want to receive the raw events and GenICam invalidator events.

Declaration

public PvResult RegisterEventSink(SWIGTYPE_p_IPvDeviceEventSink aEventSink)

Parameters

Type	Name	Description
SWIGTYPE_p_IPvDeviceEventSink	aEventSink	Pointer to an object implementing the IPvDeviceEventSink interface.

Returns

Type	Description
PvResult	OK on success.

RegisterGenInvalidator(string)

Registers (and forward to the device serial object) invalidation events for a parameter identified by its name.

Declaration

public virtual PvResult RegisterGenInvalidator(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.

Returns

Type	Description
PvResult	OK on success.

SetGenBooleanValue(string, bool)

Sets the value of a Boolean identified by its name.

Declaration

public virtual PvResult SetGenBooleanValue(string aParameterName, bool aValue)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
bool	aValue	New value for the Boolean.

Returns

Type	Description
PvResult	OK on success.

SetGenEnumValue(string, string)

Sets the value of an enumeration identified by its name.

Declaration

public virtual PvResult SetGenEnumValue(string aParameterName, string aEnumEntry)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
string	aEnumEntry	New value for the enumeration.

Returns

Type	Description
PvResult	OK on success.

SetGenRegisterData(string, byte[], long)

Sets the data contained in a register identified by its name.

Declaration

public PvResult SetGenRegisterData(string aParameterName, byte[] aDataBuffer, long aByteCount)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.
byte[]	aDataBuffer	Buffer to copy the data from.
long	aByteCount	How many bytes to copy from aDataBuffer to the register.

Returns

Type	Description
PvResult	OK on success.

UnregisterEventSink(SWIGTYPE_p_IPvDeviceEventSink)

Unregisters an event sink registered with RegisterEventSink.

Declaration

public PvResult UnregisterEventSink(SWIGTYPE_p_IPvDeviceEventSink aEventSink)

Parameters

Type	Name	Description
SWIGTYPE_p_IPvDeviceEventSink	aEventSink	Pointer to an object implementing the IPvDeviceEventSink interface.

Returns

Type	Description
PvResult	OK on success.

UnregisterGenInvalidator(string)

Unregisters (and forward to the device serial object) invalidation events for a parameter identified by its name.

Declaration

public virtual PvResult UnregisterGenInvalidator(string aParameterName)

Parameters

Type	Name	Description
string	aParameterName	Name of the parameter.

Returns

Type	Description
PvResult	OK on success.

WaitForMessagingChannelIdle(uint)

Waits for the messaging channel queue to be empty.

Declaration

public virtual PvResult WaitForMessagingChannelIdle(uint aTimeout)

Parameters

Type	Name	Description
uint	aTimeout	How long to wait for the messaging channel to become idle.

Returns

Type	Description
PvResult	OK on success.

WriteMemory(byte[], long, long)

Writes data to a the memory of a device.

Declaration

public PvResult WriteMemory(byte[] aBuffer, long aAddress, long aLength)

Parameters

Type	Name	Description
byte[]	aBuffer	Pointer to the data to write.
long	aAddress	Address where to write the data.
long	aLength	Length of the data to write, in bytes.

Returns

Type	Description
PvResult	OK on success.

WriteRegister(long, uint)

Writes a 32 bit value to a GigE Vision register.

Declaration

public virtual PvResult WriteRegister(long aAddress, uint aValue)

Parameters

Type	Name	Description
long	aAddress	Address of the register.
uint	aValue	Value to write to the register.

Returns

Type	Description
PvResult	OK on success.

Implements

IPvDeviceAdapterSwigInterface

IDisposable