Class used for register creation. More...

Public Member Functions
virtual	~IPvRegisterFactory ()
	Virtual destructor.

virtual PvResult	AddRegister (const PvString &aName, uint32_t aAddress, uint32_t aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSink aRegisterEventSink=nullptr, void aContext=nullptr)=0
	Adds a new register (Integer, Float) to the PvSoftDeviceGEV register map. More...

virtual PvResult	AddRegisterAuto (const PvString &aName, uint32_t &aAssignedAddress, uint32_t aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSink aRegisterEventSink, void aContext=nullptr)=0
	Automatically assigns an address and adds a new register (Integer, Float) to the PvSoftDeviceGEV register map. More...

virtual PvResult	AddByteArray (const PvString &aName, uint32_t aAddress, uint32_t aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSink aRegisterEventSink=nullptr, void aContext=nullptr)=0
	Adds a new array of bytes (String, Register) to the PvSoftDeviceGEV register map. More...

Detailed Description

Class used for register creation.

The AddRegister method can be used to add customer registers to the PvSoftDeviceGEV. Note however that custom registers can only be added from the IPvVirtualDeviceGEVEventSink::OnCreateCustomRegisters notification. A pointer to this register factory interface is provided with the notification.

Member Function Documentation

virtual PvResult IPvRegisterFactory::AddByteArray	(	const PvString &	aName,
		uint32_t	aAddress,
		uint32_t	aLength,
		PvGenAccessMode	aAccessMode,
		IPvRegisterEventSink *	aRegisterEventSink = `nullptr`,
		void *	aContext = `nullptr`
	)

pure virtual

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

Parameters

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

Returns

Includes:

virtual PvResult IPvRegisterFactory::AddRegister	(	const PvString &	aName,
		uint32_t	aAddress,
		uint32_t	aLength,
		PvGenAccessMode	aAccessMode,
		IPvRegisterEventSink *	aRegisterEventSink = `nullptr`,
		void *	aContext = `nullptr`
	)

pure virtual

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

Parameters

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

Returns

Includes:

virtual PvResult IPvRegisterFactory::AddRegisterAuto	(	const PvString &	aName,
		uint32_t &	aAssignedAddress,
		uint32_t	aLength,
		PvGenAccessMode	aAccessMode,
		IPvRegisterEventSink *	aRegisterEventSink,
		void *	aContext = `nullptr`
	)

pure virtual

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

Parameters

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

Returns

Includes:

The documentation for this class was generated from the following file: