ChimeraTK-DeviceAccess  03.18.00
Public Member Functions | Protected Attributes | List of all members
myRegisterInfo Class Reference
+ Inheritance diagram for myRegisterInfo:
+ Collaboration diagram for myRegisterInfo:

Public Member Functions

 myRegisterInfo (std::string path, unsigned int nbOfElements, unsigned int nbOfChannels, unsigned int nbOfDimensions, DataDescriptor dataDescriptor, bool readable, bool writeable, AccessModeFlags supportedFlags)
 
 myRegisterInfo ()=default
 
RegisterPath getRegisterName () const override
 Return full path name of the register (including modules) More...
 
unsigned int getNumberOfElements () const override
 Return number of elements per channel. More...
 
unsigned int getNumberOfChannels () const override
 Return number of channels in register. More...
 
const DataDescriptor & getDataDescriptor () const override
 Return desciption of the actual payload data for this register. More...
 
bool isReadable () const override
 Return whether the register is readable. More...
 
bool isWriteable () const override
 Return whether the register is writeable. More...
 
AccessModeFlags getSupportedAccessModes () const override
 Return all supported AccessModes for this register. More...
 
std::unique_ptr< BackendRegisterInfoBase > clone () const override
 Create copy of the object. More...
 
bool operator== (const myRegisterInfo &other) const
 
- Public Member Functions inherited from ChimeraTK::BackendRegisterInfoBase
virtual ~BackendRegisterInfoBase ()=default
 Virtual destructor. More...
 
unsigned int getNumberOfDimensions () const
 Return number of dimensions of this register. More...
 
virtual std::vector< size_t > getQualifiedAsyncId () const
 Return the fully qualified async::SubDomain ID. More...
 

Protected Attributes

RegisterPath _path
 
unsigned int _nbOfElements
 
unsigned int _nbOfChannels
 
unsigned int _nbOfDimensions
 
DataDescriptor _dataDescriptor
 
bool _readable
 
bool _writeable
 
AccessModeFlags _supportedFlags
 

Detailed Description

Definition at line 16 of file testRegisterCatalogue.cpp.

Constructor & Destructor Documentation

◆ myRegisterInfo() [1/2]

myRegisterInfo::myRegisterInfo ( std::string  path,
unsigned int  nbOfElements,
unsigned int  nbOfChannels,
unsigned int  nbOfDimensions,
DataDescriptor  dataDescriptor,
bool  readable,
bool  writeable,
AccessModeFlags  supportedFlags 
)
inline

Definition at line 18 of file testRegisterCatalogue.cpp.

◆ myRegisterInfo() [2/2]

myRegisterInfo::myRegisterInfo ( )
default

Member Function Documentation

◆ clone()

std::unique_ptr<BackendRegisterInfoBase> myRegisterInfo::clone ( ) const
inlineoverridevirtual

Create copy of the object.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 39 of file testRegisterCatalogue.cpp.

◆ getDataDescriptor()

const DataDescriptor& myRegisterInfo::getDataDescriptor ( ) const
inlineoverridevirtual

Return desciption of the actual payload data for this register.

See the description of DataDescriptor for more information.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 31 of file testRegisterCatalogue.cpp.

◆ getNumberOfChannels()

unsigned int myRegisterInfo::getNumberOfChannels ( ) const
inlineoverridevirtual

Return number of channels in register.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 29 of file testRegisterCatalogue.cpp.

◆ getNumberOfElements()

unsigned int myRegisterInfo::getNumberOfElements ( ) const
inlineoverridevirtual

Return number of elements per channel.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 27 of file testRegisterCatalogue.cpp.

◆ getRegisterName()

RegisterPath myRegisterInfo::getRegisterName ( ) const
inlineoverridevirtual

Return full path name of the register (including modules)

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 25 of file testRegisterCatalogue.cpp.

+ Here is the caller graph for this function:

◆ getSupportedAccessModes()

AccessModeFlags myRegisterInfo::getSupportedAccessModes ( ) const
inlineoverridevirtual

Return all supported AccessModes for this register.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 37 of file testRegisterCatalogue.cpp.

◆ isReadable()

bool myRegisterInfo::isReadable ( ) const
inlineoverridevirtual

Return whether the register is readable.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 33 of file testRegisterCatalogue.cpp.

◆ isWriteable()

bool myRegisterInfo::isWriteable ( ) const
inlineoverridevirtual

Return whether the register is writeable.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 35 of file testRegisterCatalogue.cpp.

◆ operator==()

bool myRegisterInfo::operator== ( const myRegisterInfo &  other) const
inline

Definition at line 44 of file testRegisterCatalogue.cpp.

Member Data Documentation

◆ _dataDescriptor

DataDescriptor myRegisterInfo::_dataDescriptor
protected

Definition at line 53 of file testRegisterCatalogue.cpp.

◆ _nbOfChannels

unsigned int myRegisterInfo::_nbOfChannels
protected

Definition at line 52 of file testRegisterCatalogue.cpp.

◆ _nbOfDimensions

unsigned int myRegisterInfo::_nbOfDimensions
protected

Definition at line 52 of file testRegisterCatalogue.cpp.

◆ _nbOfElements

unsigned int myRegisterInfo::_nbOfElements
protected

Definition at line 52 of file testRegisterCatalogue.cpp.

◆ _path

RegisterPath myRegisterInfo::_path
protected

Definition at line 51 of file testRegisterCatalogue.cpp.

◆ _readable

bool myRegisterInfo::_readable
protected

Definition at line 54 of file testRegisterCatalogue.cpp.

◆ _supportedFlags

AccessModeFlags myRegisterInfo::_supportedFlags
protected

Definition at line 55 of file testRegisterCatalogue.cpp.

◆ _writeable

bool myRegisterInfo::_writeable
protected

Definition at line 54 of file testRegisterCatalogue.cpp.

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