Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvRegisterFactory Class Referenceabstract

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=NULL, void *aContext=NULL)=0
 Adds a new 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 IPvSoftDeviceGEVEventSink::OnCreateCustomRegisters notification. A pointer to this register factory interface is provided with the notification.

Member Function Documentation

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

Adds a new register to the PvSoftDeviceGEV register map.

Parameters
[in]aNameThe name of the new register to create.
[in]aAddressThe address for the new register. It must be unique and must not overlap previously-allocated register space.
[in]aLengthRegister length, in bytes. Must be divisible by 4.
[in]aAccessModeAccess mode of the register: PvGenAccessModeReadOnly, PvGenAccessModeReadWrite, or PvGenAccessModeWriteOnly.
[in]aRegisterEventSinkAn optional event sink to register on creation.
[in]aContextA 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 files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com