Class PvSoftDeviceGEV

Implements a software-based GigE Vision Device with full GVCP and GVSP support.

Inheritance

object

IPvVirtualDeviceGEV

IPvSoftDeviceGEV

PvSoftDeviceGEV

Implements

IDisposable

Inherited Members

IPvVirtualDeviceGEV.swigCMemOwn

IPvVirtualDeviceGEV.Dispose()

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 PvSoftDeviceGEV : IPvSoftDeviceGEV, IDisposable

Constructors

PvSoftDeviceGEV()

Constructor.

Declaration

public PvSoftDeviceGEV()

Methods

AddStream(IPvSWStreamingChannelSourceSwigInterface)

Adds a new stream to the #PvSoftDeviceGEV.

Declaration

public override PvResult AddStream(IPvSWStreamingChannelSourceSwigInterface aSource)

Parameters

Type	Name	Description
IPvSWStreamingChannelSourceSwigInterface	aSource	Interface to a user-provided source.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aSource is NULL. #PvResult::Code::STATE_ERROR if the #PvSoftDeviceGEV is already running. #PvResult::Code::NOT_SUPPORTED if the maximum stream count has already been reached.

Overrides

IPvSoftDeviceGEV.AddStream(IPvSWStreamingChannelSourceSwigInterface)

Dispose(bool)

Dispose

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

IPvSoftDeviceGEV.Dispose(bool)

GetGenICamXMLFile(out string)

Returns the GenICam XML file of the device.

Declaration

public override PvResult GetGenICamXMLFile(out string aString)

Parameters

Type	Name	Description
string	aString	[out] 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)

Overrides

IPvVirtualDeviceGEV.GetGenICamXMLFile(out string)

GetInfo()

Obtains the information interface of the #PvSoftDeviceGEV.

Declaration

public override IPvVirtualDeviceGEVInfo GetInfo()

Returns

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

Overrides

IPvVirtualDeviceGEV.GetInfo()

GetMessagingChannel()

Obtains the messaging channel interface of the #PvSoftDeviceGEV.

Declaration

public override IPvMessageChannel GetMessagingChannel()

Returns

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

Overrides

IPvVirtualDeviceGEV.GetMessagingChannel()

GetRegisterMap()

Obtains the register map interface of the #PvSoftDeviceGEV.

Declaration

public override IPvRegisterMap GetRegisterMap()

Returns

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

Overrides

IPvVirtualDeviceGEV.GetRegisterMap()

GetStatistics()

Obtains the statistics interface of the #PvSoftDeviceGEV.

Declaration

public override IPvVirtualDeviceGEVStatistics GetStatistics()

Returns

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

Overrides

IPvVirtualDeviceGEV.GetStatistics()

RegisterEventSink(IPvVirtualDeviceGEVEventSink)

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

Declaration

public override 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 NULL or already registered.

Overrides

IPvVirtualDeviceGEV.RegisterEventSink(IPvVirtualDeviceGEVEventSink)

SetActionHandler(IActionHandler)

Sets the action handler for processing action commands.

Declaration

public override PvResult SetActionHandler(IActionHandler aActionHandler)

Parameters

Type	Name	Description
IActionHandler	aActionHandler	The action handler implementation.

Returns

Type	Description
PvResult	PvResult.

Overrides

IPvVirtualDeviceGEV.SetActionHandler(IActionHandler)

SetGenDCEnabled(bool)

Enables or disables GenDC (Generic Data Container) streaming mode on the transmitter.

Declaration

public override PvResult SetGenDCEnabled(bool aEnabled)

Parameters

Type	Name	Description
bool	aEnabled	True to enable GenDC, false to disable.

Returns

Type	Description
PvResult	PV_OK on success, or an error code on failure.

Overrides

IPvSoftDeviceGEV.SetGenDCEnabled(bool)

SetRTPProtocolEnabled(bool)

Enables the option of using RTP for streaming.

Declaration

public override PvResult SetRTPProtocolEnabled(bool aEnabled)

Parameters

Type	Name	Description
bool	aEnabled	Toggles RTP support.

Returns

Type	Description
PvResult	#PvResult::Code::OK

Overrides

IPvSoftDeviceGEV.SetRTPProtocolEnabled(bool)

SetStreamTimestamping(bool)

Enables stream timestamping on all sources. 'True' by default.

Declaration

public PvResult SetStreamTimestamping(bool aEnabled)

Parameters

Type	Name	Description
bool	aEnabled	Toggles stream timestamping.

Returns

Type	Description
PvResult	#PvResult::Code::OK

SetTCPTransportEnabled(bool)

Enables experimental TCP transport.

Declaration

public override PvResult SetTCPTransportEnabled(bool aEnabled)

Parameters

Type	Name	Description
bool	aEnabled	Toggles TCP support.

Returns

Type	Description
PvResult	#PvResult::Code::OK

Overrides

IPvSoftDeviceGEV.SetTCPTransportEnabled(bool)

SetUserSetCount(uint)

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

Declaration

public override 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.

Overrides

IPvVirtualDeviceGEV.SetUserSetCount(uint)

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 override PvResult SetUserSetNotify(IPvUserSetNotify aUserSetNotify)

Parameters

Type	Name	Description
IPvUserSetNotify	aUserSetNotify	The user set notification handler implementation.

Returns

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

Overrides

IPvVirtualDeviceGEV.SetUserSetNotify(IPvUserSetNotify)

Start(string)

Starts the #PvSoftDeviceGEV.

Declaration

public override 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.

Overrides

IPvVirtualDeviceGEV.Start(string)

Stop()

Stops the #PvSoftDeviceGEV.

Declaration

public override PvResult Stop()

Returns

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

Overrides

IPvVirtualDeviceGEV.Stop()

UnregisterEventSink(IPvVirtualDeviceGEVEventSink)

Unregisters a previously registered event sink.

Declaration

public override 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 NULL.

Overrides

IPvVirtualDeviceGEV.UnregisterEventSink(IPvVirtualDeviceGEVEventSink)

Implements

IDisposable