Class PvDeviceGEV

Connect, configure and control a GigE Vision device

Inheritance

object

PvDevice

PvDeviceGEV

Implements

IDisposable

Inherited Members

PvDevice.swigCMemOwn

PvDevice.Dispose()

PvDevice.OnLinkDisconnected

PvDevice.CreateAndConnect(PvDeviceInfo, ref PvResult)

PvDevice.CreateAndConnect(string, ref PvResult)

PvDevice.Free(PvDevice)

PvDevice.GetType()

PvDevice.Disconnect()

PvDevice.StreamEnable(uint)

PvDevice.StreamEnable()

PvDevice.StreamDisable(uint)

PvDevice.StreamDisable()

PvDevice.DumpGenICamXML(string)

PvDevice.GetDefaultGenICamXMLFilename(out string)

PvDevice.ReadMemory(long, byte[], long)

PvDevice.WriteMemory(long, byte[], long)

PvDevice.WaitForMessagingChannelIdle(uint)

PvDevice.RegisterEventSink(PvDeviceEventSinkSwigInterface)

PvDevice.UnregisterEventSink(PvDeviceEventSinkSwigInterface)

PvDevice.GetUniqueID(out string)

PvDevice.Parameters

PvDevice.CommunicationParameters

PvDevice.HeartbeatThreadPriority

PvDevice.InterruptLinkThreadPriority

PvDevice.InterruptQueueThreadPriority

PvDevice.PayloadSize

PvDevice.Connected

PvDevice.PleoraPowered

PvDevice.OnLinkReconnected

PvDevice.OnEvent

PvDevice.OnEventSafe

PvDevice.OnEventGenICam

PvDevice.OnCmdLinkRead

PvDevice.OnCmdLinkReadSafe

PvDevice.OnCmdLinkWrite

PvDevice.OnCmdLinkWriteSafe

PvDevice.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class PvDeviceGEV : PvDevice, IDisposable

Constructors

PvDeviceGEV()

Constructor.

Declaration

public PvDeviceGEV()

Properties

AccessType

Gets the access type of the connected device.

Declaration

public PvAccessType AccessType { get; }

Property Value

Type	Description
PvAccessType

Class

Gets the GigE Vision device class of the connected device.

Declaration

public PvDeviceClass Class { get; }

Property Value

Type	Description
PvDeviceClass

IPAddress

Gets the IP address of the connected device.

Declaration

public string IPAddress { get; }

Property Value

Type	Description
string

IsConnected

Gets whether this PvDevice is currently connected to a GigE Vision device.

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
bool

IsPleoraPowered

Gets whether this PvDevice is currently connected to a Pleora powered GigE Vision device.

Declaration

public bool IsPleoraPowered { get; }

Property Value

Type	Description
bool

MACAddress

Gets the MAC address of the connected device.

Declaration

public string MACAddress { get; }

Property Value

Type	Description
string

Methods

Connect(PvDeviceInfo)

Connect to a GigE Vision device.

Declaration

public override PvResult Connect(PvDeviceInfo aDeviceInfo)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	The GigE Vision device's network connectivity information; a #PvDeviceInfo object.

Returns

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

Overrides

PvDevice.Connect(PvDeviceInfo)

Connect(PvDeviceInfo, PvAccessType)

Connect to a GigE Vision device (found with #PvSystem, #PvInterface, #PvDeviceInfo).

Declaration

public PvResult Connect(PvDeviceInfo aDeviceInfo, PvAccessType aAccessType)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	The GigE Vision device's network connectivity information; a #PvDeviceInfo object.
PvAccessType	aAccessType	The GigE Vision device's availability for connections by multiple controllers. See #PvAccessType.

Returns

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

Connect(string)

Connect to a GigE Vision device with the default access control mode.

Declaration

public override PvResult Connect(string aInfo)

Parameters

Type	Name	Description
string	aInfo	Information that uniquely identifies the GigE Vision device. You may use one of the following: - GigE Vision device's MAC address. Use the form 00:11:22:33:44:5F. - GigE Vision device's IP Address. Use the form 192.168.1.114. - GigE Vision device's DeviceUserID.

Returns

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

Overrides

PvDevice.Connect(string)

Connect(string, PvAccessType)

Connect to a GigE Vision device.

Declaration

public PvResult Connect(string aInfo, PvAccessType aAccessType)

Parameters

Type	Name	Description
string	aInfo	Information that uniquely identifies the GigE Vision device. You may use one of the following: - GigE Vision device's MAC address. Use the form 00:11:22:33:44:5F. - GigE Vision device's IP Address. Use the form 192.168.1.114. - GigE Vision device's DeviceUserID.
PvAccessType	aAccessType	The access control privilege to set at the time of connection. See #PvAccessType.

Returns

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

Dispose(bool)

Dispose

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

PvDevice.Dispose(bool)

GetAccessType(string, ref PvAccessType)

Returns the current access type of a device identified by its IP address.

Declaration

public static PvResult GetAccessType(string aDeviceIPAddress, ref PvAccessType aAccessType)

Parameters

Type	Name	Description
string	aDeviceIPAddress	The IP address of the GigE Vision device.
PvAccessType	aAccessType	The access type of the GigE Vision device on success. See #PvAccessType enum. PvAccessUnknown on failure.

Returns

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

NegotiatePacketSize()

Automatically finds and sets the optimal packet size.

Declaration

public PvResult NegotiatePacketSize()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND

NegotiatePacketSize(uint)

Automatically finds and sets the optimal packet size.

Declaration

public PvResult NegotiatePacketSize(uint aChannel)

Parameters

Type	Name	Description
uint	aChannel	The streaming channel. Use 0 for most GigE Vision devices only supporting a single streaming channel.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND

NegotiatePacketSize(uint, uint)

Automatically finds and sets the optimal packet size.

Declaration

public PvResult NegotiatePacketSize(uint aChannel, uint aDefaultPacketSize)

Parameters

Type	Name	Description
uint	aChannel	The streaming channel. Use 0 for most GigE Vision devices only supporting a single streaming channel.
uint	aDefaultPacketSize	The packet size to use, in bytes, should the negotiation fail. Use 1476 for a safe packet size; 0 to continue using the GigE Vision device's original setting in case of failure.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND

ReadRegister(long, out uint)

Read a 32-bit value from a specific register address on the GigE Vision device.

Declaration

public PvResult ReadRegister(long aAddress, out uint aValue)

Parameters

Type	Name	Description
long	aAddress	The GigE Vision device's register address (mod 4).
uint	aValue	The value read from the GigE Vision device's register.

Returns

Type	Description
PvResult	See #WriteMemory.

ResetStreamDestination()

Resets the UDP/IP streaming destination of the GigE Vision device.

Declaration

public PvResult ResetStreamDestination()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR

ResetStreamDestination(uint)

Resets the UDP/IP streaming destination of the GigE Vision device.

Declaration

public PvResult ResetStreamDestination(uint aChannel)

Parameters

Type	Name	Description
uint	aChannel	See the aChannel parameter for the #SetStreamDestination method.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR

SetIPConfiguration(string, string)

Sets the GigE Vision device's IP address.

Declaration

public static PvResult SetIPConfiguration(string aMACAddress, string aIP)

Parameters

Type	Name	Description
string	aMACAddress	The GigE Vision device's MAC address.
string	aIP	The GigE Vision device's new IP address.

Returns

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

SetIPConfiguration(string, string, string)

Sets the GigE Vision device's IP address.

Declaration

public static PvResult SetIPConfiguration(string aMACAddress, string aIP, string aSubnetMask)

Parameters

Type	Name	Description
string	aMACAddress	The GigE Vision device's MAC address.
string	aIP	The GigE Vision device's new IP address.
string	aSubnetMask	The GigE Vision device's new subnet mask.

Returns

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

SetIPConfiguration(string, string, string, string)

Sets the GigE Vision device's IP address.

Declaration

public static PvResult SetIPConfiguration(string aMACAddress, string aIP, string aSubnetMask, string aGateway)

Parameters

Type	Name	Description
string	aMACAddress	The GigE Vision device's MAC address.
string	aIP	The GigE Vision device's new IP address.
string	aSubnetMask	The GigE Vision device's new subnet mask.
string	aGateway	The GigE Vision device's new gateway.

Returns

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

SetPacketSize(uint)

Sets the packet size for a streaming channel.

Declaration

public PvResult SetPacketSize(uint aPacketSize)

Parameters

Type	Name	Description
uint	aPacketSize	The packet size to use for aChannel.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND

SetPacketSize(uint, uint)

Sets the packet size for a streaming channel.

Declaration

public PvResult SetPacketSize(uint aPacketSize, uint aChannel)

Parameters

Type	Name	Description
uint	aPacketSize	The packet size to use for aChannel.
uint	aChannel	The streaming channel. Use 0 for most GigE Vision devices only supporting a single streaming channel.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND

SetStreamDestination(string, ushort)

Set the UDP/IP destination to which the GigE Vision device transmits data.

Declaration

public PvResult SetStreamDestination(string aIPAddress, ushort aDataPort)

Parameters

Type	Name	Description
string	aIPAddress	The receiving PC's IP address (GenICam feature name: GevSCDA) or a multicast IP address.
ushort	aDataPort	The receiving PC's data port (feature name: GevSCPHostPort) or the multicast port.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR

SetStreamDestination(string, ushort, uint)

Set the UDP/IP destination to which the GigE Vision device transmits data.

Declaration

public PvResult SetStreamDestination(string aIPAddress, ushort aDataPort, uint aChannel)

Parameters

Type	Name	Description
string	aIPAddress	The receiving PC's IP address (GenICam feature name: GevSCDA) or a multicast IP address.
ushort	aDataPort	The receiving PC's data port (feature name: GevSCPHostPort) or the multicast port.
uint	aChannel	The GigE Vision stream channel; the channel over which the GigE Vision device transmits images. Use 0 for device having supporting a single streaming channel.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::NOT_CONNECTED #PvResult::Code::TIMEOUT #PvResult::Code::GENERIC_ERROR

WriteRegister(long, uint)

Write a 32-bit value to a specific register address on the GigE Vision device.

Declaration

public PvResult WriteRegister(long aAddress, uint aValue)

Parameters

Type	Name	Description
long	aAddress	The GigE Vision device's register address (mod 4).
uint	aValue	The value to be written to the register.

Returns

Type	Description
PvResult	See #WriteMemory.

WriteRegister(long, uint, bool)

Write a 32-bit value to a specific register address on the GigE Vision device.

Declaration

public PvResult WriteRegister(long aAddress, uint aValue, bool aAcknowledge)

Parameters

Type	Name	Description
long	aAddress	The GigE Vision device's register address (mod 4).
uint	aValue	The value to be written to the register.
bool	aAcknowledge	When sending the command, sets the acknowledge requested bit and waits for that acknowledge. If set to false, the acknowledge is not requested and the method returns as soon as the command has been pushed in the UDP socket. If not specified true is assumed.

Returns

Type	Description
PvResult	See #WriteMemory.

Implements

IDisposable