Class IPvRegisterFactory

Class used for register creation.

Inheritance

object

IPvRegisterFactory

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

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

AddByteArray(string, uint, uint, PvGenAccessMode)

Adds a new array of bytes (String, Register) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddByteArray(string aName, uint aAddress, uint aLength, PvGenAccessMode aAccessMode)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAddress	The address for the new register. It must be unique and must not overlap previously-allocated register space.
uint	aLength	Register length, in bytes. Must be divisible by 4.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.

Returns

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

AddByteArray(string, uint, uint, PvGenAccessMode, IPvRegisterEventSinkSwigInterface)

Adds a new array of bytes (String, Register) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddByteArray(string aName, uint aAddress, uint aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSinkSwigInterface aRegisterEventSink)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAddress	The address for the new register. It must be unique and must not overlap previously-allocated register space.
uint	aLength	Register length, in bytes. Must be divisible by 4.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
IPvRegisterEventSinkSwigInterface	aRegisterEventSink	An optional event sink to register on creation.

Returns

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

AddByteArray(string, uint, uint, PvGenAccessMode, IPvRegisterEventSinkSwigInterface, SWIGTYPE_p_void)

Adds a new array of bytes (String, Register) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddByteArray(string aName, uint aAddress, uint aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSinkSwigInterface aRegisterEventSink, SWIGTYPE_p_void aContext)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAddress	The address for the new register. It must be unique and must not overlap previously-allocated register space.
uint	aLength	Register length, in bytes. Must be divisible by 4.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
IPvRegisterEventSinkSwigInterface	aRegisterEventSink	An optional event sink to register on creation.
SWIGTYPE_p_void	aContext	A contextual pointer that is specific to the register. It can be retrieved using #IPvRegisterInfo::GetContext.

Returns

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

AddRegister(string, uint, uint, PvGenAccessMode)

Adds a new register (Integer, Float) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddRegister(string aName, uint aAddress, uint aLength, PvGenAccessMode aAccessMode)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAddress	The address for the new register. It must be unique and must not overlap previously-allocated register space.
uint	aLength	Register length, in bytes. Must be 4 or 8.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.

Returns

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

AddRegister(string, uint, uint, PvGenAccessMode, IPvRegisterEventSinkSwigInterface)

Adds a new register (Integer, Float) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddRegister(string aName, uint aAddress, uint aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSinkSwigInterface aRegisterEventSink)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAddress	The address for the new register. It must be unique and must not overlap previously-allocated register space.
uint	aLength	Register length, in bytes. Must be 4 or 8.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
IPvRegisterEventSinkSwigInterface	aRegisterEventSink	An optional event sink to register on creation.

Returns

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

AddRegister(string, uint, uint, PvGenAccessMode, IPvRegisterEventSinkSwigInterface, SWIGTYPE_p_void)

Adds a new register (Integer, Float) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddRegister(string aName, uint aAddress, uint aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSinkSwigInterface aRegisterEventSink, SWIGTYPE_p_void aContext)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAddress	The address for the new register. It must be unique and must not overlap previously-allocated register space.
uint	aLength	Register length, in bytes. Must be 4 or 8.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
IPvRegisterEventSinkSwigInterface	aRegisterEventSink	An optional event sink to register on creation.
SWIGTYPE_p_void	aContext	A contextual pointer that is specific to the register. It can be retrieved using #IPvRegisterInfo::GetContext.

Returns

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

AddRegisterAuto(string, out uint, uint, PvGenAccessMode, IPvRegisterEventSinkSwigInterface)

Automatically assigns an address and adds a new register (Integer, Float) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddRegisterAuto(string aName, out uint aAssignedAddress, uint aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSinkSwigInterface aRegisterEventSink)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAssignedAddress	Address automatically assigned.
uint	aLength	Register length, in bytes. Must be 4 or 8.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
IPvRegisterEventSinkSwigInterface	aRegisterEventSink	An optional event sink to register on creation.

Returns

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

AddRegisterAuto(string, out uint, uint, PvGenAccessMode, IPvRegisterEventSinkSwigInterface, SWIGTYPE_p_void)

Automatically assigns an address and adds a new register (Integer, Float) to the #PvSoftDeviceGEV register map.

Declaration

public virtual PvResult AddRegisterAuto(string aName, out uint aAssignedAddress, uint aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSinkSwigInterface aRegisterEventSink, SWIGTYPE_p_void aContext)

Parameters

Type	Name	Description
string	aName	The name of the new register to create.
uint	aAssignedAddress	Address automatically assigned.
uint	aLength	Register length, in bytes. Must be 4 or 8.
PvGenAccessMode	aAccessMode	Access mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
IPvRegisterEventSinkSwigInterface	aRegisterEventSink	An optional event sink to register on creation.
SWIGTYPE_p_void	aContext	A contextual pointer that is specific to the register. It can be retrieved using #IPvRegisterInfo::GetContext.

Returns

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

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvRegisterFactory()

Destructor.

Declaration

protected ~IPvRegisterFactory()

Implements

IDisposable