DUECA/DUSIME
Protected Member Functions | Protected Attributes | List of all members
dueca::DataWriterBase Class Reference

Common base class for DataWriter instantiations. More...

Inheritance diagram for dueca::DataWriterBase:
Inheritance graph
[legend]
Collaboration diagram for dueca::DataWriterBase:
Collaboration graph
[legend]

Protected Member Functions

 DataWriterBase (ChannelWriteToken &token, const DataTimeSpec &ts)
 Constructor. More...
 
void releaseAccess (void *data_ptr)
 Releasing the read access means that the data will be made accessible for reading. More...
 
void baseCheckAccess (uint32_t magic)
 Verify the magic number and validity for access. More...
 

Protected Attributes

ChannelWriteTokentoken
 Access to the channel. More...
 
DataTimeSpec ts
 Time specification to be used. More...
 

Detailed Description

Common base class for DataWriter instantiations.

Constructor & Destructor Documentation

◆ DataWriterBase()

dueca::DataWriterBase::DataWriterBase ( ChannelWriteToken token,
const DataTimeSpec ts 
)
inlineprotected

Constructor.

Parameters
tokenToken of the channel to be written to
tsTime for writing

Member Function Documentation

◆ releaseAccess()

void dueca::DataWriterBase::releaseAccess ( void *  data_ptr)
inlineprotected

Releasing the read access means that the data will be made accessible for reading.

Parameters
data_ptrPointer for passing the data

◆ baseCheckAccess()

void dueca::DataWriterBase::baseCheckAccess ( uint32_t  magic)
inlineprotected

Verify the magic number and validity for access.

Parameters
magicmagic number, must match the data type magic number
Exceptions
InvalidChannelAccessReturn,ifthe magic is not correct or the token is not valid.

Member Data Documentation

◆ token

ChannelWriteToken& dueca::DataWriterBase::token
protected

Access to the channel.

◆ ts

DataTimeSpec dueca::DataWriterBase::ts
protected

Time specification to be used.


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