Class IPvMessageChannel

Messaging channel interface of the software-based GigE Vision Device.

Inheritance

object

IPvMessageChannel

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 IPvMessageChannel : IDisposable

Fields

swigCMemOwn

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvMessageChannel()

Destructor.

Declaration

protected ~IPvMessageChannel()

FireEvent(ushort)

Fires a messaging channel event.

Declaration

public virtual PvResult FireEvent(ushort aEventID)

Parameters

Type	Name	Description
ushort	aEventID	Event ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::STATE_ERROR if the messaging channel is not opened.

FireEvent(ushort, byte[], uint)

Fires a messaging channel event.

Declaration

public virtual PvResult FireEvent(ushort aEventID, byte[] aData, uint aDataLength)

Parameters

Type	Name	Description
ushort	aEventID	Event ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
byte[]	aData	Pointer to the data attached to the event.
uint	aDataLength	Length of the aData buffer. Must be 4 or higher and 536 or lower. Must also be divisible by 4.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::STATE_ERROR if the messaging channel is not opened. #PvResult::Code::INVALID_PARAMETER if the data is nullptr, data length is too small, too large, or not divisible by 4.

FireEvent(ushort, byte[], uint, ulong)

Fires a messaging channel event.

Declaration

public virtual PvResult FireEvent(ushort aEventID, byte[] aData, uint aDataLength, ulong aBlockID)

Parameters

Type	Name	Description
ushort	aEventID	Event ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
byte[]	aData	Pointer to the data attached to the event.
uint	aDataLength	Length of the aData buffer. Must be 4 or higher and 536 or lower. Must also be divisible by 4.
ulong	aBlockID	Block ID that the event is related to or zero.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::STATE_ERROR if the messaging channel is not opened. #PvResult::Code::INVALID_PARAMETER if the data is nullptr, data length is too small, too large, or not divisible by 4.

FireEvent(ushort, byte[], uint, ulong, ushort)

Fires a messaging channel event.

Declaration

public virtual PvResult FireEvent(ushort aEventID, byte[] aData, uint aDataLength, ulong aBlockID, ushort aChannelIndex)

Parameters

Type	Name	Description
ushort	aEventID	Event ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
byte[]	aData	Pointer to the data attached to the event.
uint	aDataLength	Length of the aData buffer. Must be 4 or higher and 536 or lower. Must also be divisible by 4.
ulong	aBlockID	Block ID that the event is related to or zero.
ushort	aChannelIndex	Channel index that the event is related to or 0xFFFF if no stream channel involved.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::STATE_ERROR if the messaging channel is not opened. #PvResult::Code::INVALID_PARAMETER if the data is nullptr, data length is too small, too large, or not divisible by 4.

FireEvent(ushort, ulong)

Fires a messaging channel event.

Declaration

public virtual PvResult FireEvent(ushort aEventID, ulong aBlockID)

Parameters

Type	Name	Description
ushort	aEventID	Event ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
ulong	aBlockID	Block ID that the event is related to or zero.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::STATE_ERROR if the messaging channel is not opened.

FireEvent(ushort, ulong, ushort)

Fires a messaging channel event.

Declaration

public virtual PvResult FireEvent(ushort aEventID, ulong aBlockID, ushort aChannelIndex)

Parameters

Type	Name	Description
ushort	aEventID	Event ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
ulong	aBlockID	Block ID that the event is related to or zero.
ushort	aChannelIndex	Channel Index that the event is related to or 0xFFFF if no stream channel involved.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::STATE_ERROR if the messaging channel is not opened.

IsOpened()

Indicates whether the messaging channel is open.

Declaration

public virtual bool IsOpened()

Returns

Type	Description
bool	True if open.

Implements

IDisposable