Class IPvVirtualDeviceGEV

Interface to the main class of the software-based GigE Vision Device.

Inheritance

object

IPvVirtualDeviceGEV

IPvSoftDeviceGEV

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 IPvVirtualDeviceGEV : 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

~IPvVirtualDeviceGEV()

Destructor.

Declaration

protected ~IPvVirtualDeviceGEV()

GetGenICamXMLFile(out string)

Returns the GenICam XML file of the device.

Declaration

public virtual PvResult GetGenICamXMLFile(out string aString)

Parameters

Type	Name	Description
string	aString	String where the XML file is copied.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success #PvResult::Code::STATE_ERROR if the GenICam XML file is not available (likely Start has not been called yet)

GetInfo()

Obtains the information interface of the #PvSoftDeviceGEV.

Declaration

public virtual IPvVirtualDeviceGEVInfo GetInfo()

Returns

Type	Description
IPvVirtualDeviceGEVInfo	Information interface of the #PvSoftDeviceGEV or nullptr if the device is not running.

GetMessagingChannel()

Obtains the messaging channel interface of the #PvSoftDeviceGEV.

Declaration

public virtual IPvMessageChannel GetMessagingChannel()

Returns

Type	Description
IPvMessageChannel	Messaging channel interface of the #PvSoftDeviceGEV or nullptr if the device is not running.

GetRegisterMap()

Obtains the register map interface of the #PvSoftDeviceGEV.

Declaration

public virtual IPvRegisterMap GetRegisterMap()

Returns

Type	Description
IPvRegisterMap	Register map interface of the #PvSoftDeviceGEV or nullptr if the device is not running.

GetStatistics()

Obtains the statistics interface of the #PvSoftDeviceGEV.

Declaration

public virtual IPvVirtualDeviceGEVStatistics GetStatistics()

Returns

Type	Description
IPvVirtualDeviceGEVStatistics	Statistics interface of the #PvSoftDeviceGEV or nullptr if the device is not running.

RegisterEventSink(IPvVirtualDeviceGEVEventSink)

Registers an event sink to receive notifications from the #PvSoftDeviceGEV.

Declaration

public virtual PvResult RegisterEventSink(IPvVirtualDeviceGEVEventSink aEventSink)

Parameters

Type	Name	Description
IPvVirtualDeviceGEVEventSink	aEventSink	Pointer to a #PvSoftDeviceGEV event sink.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aEventSink is nullptr or already registered.

SetActionHandler(IActionHandler)

Sets the action handler for the #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetActionHandler(IActionHandler aActionHandler)

Parameters

Type	Name	Description
IActionHandler	aActionHandler	Pointer to a #PvVirtualDeviceLib::IActionHandler implementation.

Returns

Type	Description
PvResult	PvResult.

SetUserSetCount(uint)

Sets the number of user-sets supported by the #PvSoftDeviceGEV.

Declaration

public virtual PvResult SetUserSetCount(uint aCount)

Parameters

Type	Name	Description
uint	aCount	Count of user-sets supported, in addition to the default user-set.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aSource is greather than the maximum user-set count. #PvResult::Code::STATE_ERROR if the #PvSoftDeviceGEV is already running.

SetUserSetNotify(IPvUserSetNotify)

Binds in a class which will contain a callback which will be called when the state of a UsersetLoad/Save changes.

Declaration

public virtual PvResult SetUserSetNotify(IPvUserSetNotify aUserSetNotify)

Parameters

Type	Name	Description
IPvUserSetNotify	aUserSetNotify	Pointer to a #IPvUserSetNotify implementation.

Returns

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

Start(string)

Starts the #PvSoftDeviceGEV.

Declaration

public virtual PvResult Start(string aMACAddress)

Parameters

Type	Name	Description
string	aMACAddress	MAC address of the interface to bind the #PvSoftDeviceGEV to.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::STATE_ERROR if the #PvSoftDeviceGEV is already running. #PvResult::Code::INVALID_PARAMETER if the MAC address is not valid.

Stop()

Stops the #PvSoftDeviceGEV.

Declaration

public virtual PvResult Stop()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::STATE_ERROR if the #PvSoftDeviceGEV is not running.

UnregisterEventSink(IPvVirtualDeviceGEVEventSink)

Unregisters a previously registered event sink.

Declaration

public virtual PvResult UnregisterEventSink(IPvVirtualDeviceGEVEventSink aEventSink)

Parameters

Type	Name	Description
IPvVirtualDeviceGEVEventSink	aEventSink	Pointer to a #PvSoftDeviceGEV event sink.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aEventSink is nullptr.

Implements

IDisposable