Class IPvRegisterMap

Register map interface for a software-based GigE Vision Device.

Inheritance

object

IPvRegisterMap

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

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

RegisterCount

Gets the number of registers in the register map.

Declaration

public virtual uint RegisterCount { get; }

Property Value

Type	Description
uint

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvRegisterMap()

Destructor.

Declaration

protected ~IPvRegisterMap()

GetRegisterByAddress(uint)

Obtains a register from the register map based on the register's address.

Declaration

public virtual IPvRegister GetRegisterByAddress(uint aAddress)

Parameters

Type	Name	Description
uint	aAddress	Register address.

Returns

Type	Description
IPvRegister	Register interface or nullptr on failure.

GetRegisterByIndex(uint)

Obtains a register from the register map based on the register's index.

Declaration

public virtual IPvRegister GetRegisterByIndex(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	0-based index.

Returns

Type	Description
IPvRegister	Register interface or nullptr on failure.

Lock()

Locks the register map for safe register access.

Declaration

public virtual PvResult Lock()

Returns

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

Lock(uint)

Locks the register map for safe register access but fails on timeout.

Declaration

public virtual PvResult Lock(uint aTimeout)

Parameters

Type	Name	Description
uint	aTimeout	Timeout, in ms, to wait for the lock.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::STATE_ERROR if the device is not running. #PvResult::Code::TIMEOUT if the lock could not be acquired before aTimeout ran out.

Release()

Releases a lock acquired with #Lock.

Declaration

public virtual void Release()

Implements

IDisposable