Class IPvRegister

Interface that is used to access the registers of the software-based GigE Vision Device.

Inheritance

object

IPvRegisterInfo

IPvRegister

Implements

IDisposable

Inherited Members

IPvRegisterInfo.swigCMemOwn

IPvRegisterInfo.Dispose()

IPvRegisterInfo.GetContext()

IPvRegisterInfo.Name

IPvRegisterInfo.Address

IPvRegisterInfo.Length

IPvRegisterInfo.IsWritable

IPvRegisterInfo.IsReadable

IPvRegisterInfo.IsArrayOfBytes

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 IPvRegister : IPvRegisterInfo, IDisposable

Methods

AddEventSink(IPvRegisterEventSink)

Registers a #IPvRegisterEventSink for register callbacks.

Declaration

public virtual PvResult AddEventSink(IPvRegisterEventSink aEventSink)

Parameters

Type	Name	Description
IPvRegisterEventSink	aEventSink	Pointer to the event sink.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if the event sink is nullptr or was previously registered.

See Also

IPvRegisterEventSink

Dispose(bool)

Dispose

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

IPvRegisterInfo.Dispose(bool)

Read(byte[], uint)

Reads a register to an array of bytes.

Declaration

public virtual PvResult Read(byte[] aData, uint aByteCount)

Parameters

Type	Name	Description
byte[]	aData	Pointer to the data where the data is read to.
uint	aByteCount	Length of the read operation.

Returns

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

Read(byte[], uint, uint)

Reads a register to an array of bytes.

Declaration

public virtual PvResult Read(byte[] aData, uint aByteCount, uint aOffset)

Parameters

Type	Name	Description
byte[]	aData	Pointer to the data where the data is read to.
uint	aByteCount	Length of the read operation.
uint	aOffset	Offset (in bytes) of the read operation in the register.

Returns

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

Read(out string)

Reads the register content to a string.

Declaration

public virtual PvResult Read(out string aValue)

Parameters

Type	Name	Description
string	aValue	Output of the read operation.

Returns

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

Read(out uint)

Reads the register content to a 4-byte unsigned integer.

Declaration

public virtual PvResult Read(out uint aValue)

Parameters

Type	Name	Description
uint	aValue	Output of the read operation.

Returns

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

Read(out uint, uint)

Reads the register content to a 4-byte unsigned integer.

Declaration

public virtual PvResult Read(out uint aValue, uint aOffset)

Parameters

Type	Name	Description
uint	aValue	Output of the read operation.
uint	aOffset	Offset of the read operation in the register.

Returns

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

ReadDouble(out double)

Reads the register content to a double precision floating point.

Declaration

public virtual PvResult ReadDouble(out double aValue)

Parameters

Type	Name	Description
double	aValue	Output of the read operation.

Returns

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

ReadFloat(out float)

Reads the register content to a 4-byte float.

Declaration

public virtual PvResult ReadFloat(out float aValue)

Parameters

Type	Name	Description
float	aValue	Output of the read operation.

Returns

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

RemoveEventSink(IPvRegisterEventSink)

Removes an event sink registered with AddEventSink.

Declaration

public virtual PvResult RemoveEventSink(IPvRegisterEventSink aEventSink)

Parameters

Type	Name	Description
IPvRegisterEventSink	aEventSink	Pointer to the event sink that is being removed.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if the event sink is nullptr or was not previously registered.

Write(byte[], uint)

Writes an array of bytes to a register.

Declaration

public virtual PvResult Write(byte[] aData, uint aByteCount)

Parameters

Type	Name	Description
byte[]	aData	Pointer to the data to write to the register.
uint	aByteCount	Length of write operation.

Returns

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

Write(byte[], uint, uint)

Writes an array of bytes to a register.

Declaration

public virtual PvResult Write(byte[] aData, uint aByteCount, uint aOffset)

Parameters

Type	Name	Description
byte[]	aData	Pointer to the data to write to the register.
uint	aByteCount	Length of write operation.
uint	aOffset	Offset (in bytes) of the write operation in the register.

Returns

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

Write(string)

Writes the register content from a string.

Declaration

public virtual PvResult Write(string aValue)

Parameters

Type	Name	Description
string	aValue	Value to write to the register.

Returns

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

Write(uint)

Writes the register content from a 4-byte unsigned integer.

Declaration

public virtual PvResult Write(uint aValue)

Parameters

Type	Name	Description
uint	aValue	Value to write to the register.

Returns

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

Write(uint, uint)

Writes the register content from a 4-byte unsigned integer.

Declaration

public virtual PvResult Write(uint aValue, uint aOffset)

Parameters

Type	Name	Description
uint	aValue	Value to write to the register.
uint	aOffset	Offset of the write operation in the register.

Returns

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

WriteDouble(double)

Writes the register content from a double precision floating point.

Declaration

public virtual PvResult WriteDouble(double aValue)

Parameters

Type	Name	Description
double	aValue	Value to write to the register.

Returns

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

WriteFloat(float)

Writes the register content from a float.

Declaration

public virtual PvResult WriteFloat(float aValue)

Parameters

Type	Name	Description
float	aValue	Value to write to the register.

Returns

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

Implements

IDisposable