DUECA/DUSIME
Classes | Namespaces | Typedefs | Functions | Variables
ChannelDef.hxx File Reference

Definitions for specifying channel properties. More...

Include dependency graph for ChannelDef.hxx:
This graph shows which files directly or indirectly include this file:

Classes

struct  dueca::Channel
 Collection of definitions for modifying channel behaviour. More...
 

Namespaces

 std
 print the IncoRole to a stream
 

Typedefs

typedef uint16_t dueca::entryid_type
 Definition of the entry id type; distinguishes between different entries in a channel. More...
 

Functions

bool dueca::isTimeAspectEvent (const Channel::EntryTimeAspect &t)
 Convenience function, returns true if an event is acceptable or requested. More...
 
bool dueca::isReadingModeReservation (const Channel::ReadingMode &m)
 Convenience function, returns true if a events need to be saved up while there is no reader. More...
 
bool dueca::isSequentialRead (const Channel::ReadingMode &m, bool eventtype)
 Convenience function, returns true if sequential read specified. More...
 
bool dueca::isValidReadTokenOption (const Channel::EntryArity &a)
 Convenience function, returns true if the arity option is valid for read tokens. More...
 
bool dueca::isValidWriteTokenOption (const Channel::EntryArity &a)
 Convenience function, returns true if the arity option is valid for write tokens. More...
 
bool dueca::isSingleEntryOption (const Channel::EntryArity &a)
 Convenience function, returns true if the arity option indicates a single entry. More...
 
bool dueca::isZeroEntriesAcceptable (const Channel::EntryArity &a)
 Convenience function, returns true if the arity option indicates no entries is acceptable for validity. More...
 
bool dueca::isFullPacking (const Channel::PackingMode &p)
 Convenience function, returns true if the packing method is full.
 
template<typename T >
const char * dueca::getclassname ()
 classname function, should exist for DCO objects More...
 
template<>
const char * dueca::getclassname< dueca::Channel::EntryTimeAspect > ()
 classname function, needed in case the enum must be sent over
 
template<>
const char * dueca::getclassname< dueca::Channel::EntryArity > ()
 classname function, needed in case the enum must be sent over
 
template<>
const char * dueca::getclassname< dueca::Channel::PackingMode > ()
 classname function, needed in case the enum must be sent over
 
template<>
const char * dueca::getclassname< dueca::Channel::TransportClass > ()
 classname function, needed in case the enum must be sent over
 
std::ostream & std::operator<< (std::ostream &os, const dueca::Channel::EntryTimeAspect &tc)
 Printing of the EntryTimeAspect. More...
 
std::ostream & std::operator<< (std::ostream &os, const dueca::Channel::EntryArity &tc)
 Printing of the EntryArity. More...
 
std::ostream & std::operator<< (std::ostream &os, const dueca::Channel::ReadingMode &tc)
 Printing of the ReadingMode. More...
 
std::ostream & std::operator<< (std::ostream &os, const dueca::Channel::PackingMode &tc)
 Printing of the PackingMode. More...
 
std::ostream & std::operator<< (std::ostream &os, const dueca::Channel::TransportClass &tc)
 Printing of the TransportClass. More...
 

Variables

const entryid_type dueca::entry_end = 0xffff
 Constant indicating last entry found.
 
const entryid_type dueca::entry_any = 0xffff
 Constant indicating any entry match is acceptable.
 
const entryid_type dueca::entry_bylabel = 0xfffe
 Constant indicating that entry should be selected by label.
 

Detailed Description

Definitions for specifying channel properties.

Typedef Documentation

◆ entryid_type

typedef uint16_t dueca::entryid_type

Definition of the entry id type; distinguishes between different entries in a channel.

Function Documentation

◆ isTimeAspectEvent()

bool dueca::isTimeAspectEvent ( const Channel::EntryTimeAspect t)
inline

Convenience function, returns true if an event is acceptable or requested.

◆ isReadingModeReservation()

bool dueca::isReadingModeReservation ( const Channel::ReadingMode m)
inline

Convenience function, returns true if a events need to be saved up while there is no reader.

◆ isSequentialRead()

bool dueca::isSequentialRead ( const Channel::ReadingMode m,
bool  eventtype 
)
inline

Convenience function, returns true if sequential read specified.

◆ isValidReadTokenOption()

bool dueca::isValidReadTokenOption ( const Channel::EntryArity a)
inline

Convenience function, returns true if the arity option is valid for read tokens.

◆ isValidWriteTokenOption()

bool dueca::isValidWriteTokenOption ( const Channel::EntryArity a)
inline

Convenience function, returns true if the arity option is valid for write tokens.

◆ isSingleEntryOption()

bool dueca::isSingleEntryOption ( const Channel::EntryArity a)
inline

Convenience function, returns true if the arity option indicates a single entry.

◆ isZeroEntriesAcceptable()

bool dueca::isZeroEntriesAcceptable ( const Channel::EntryArity a)
inline

Convenience function, returns true if the arity option indicates no entries is acceptable for validity.

◆ getclassname()

template<typename T >
const char * dueca::getclassname ( )

classname function, should exist for DCO objects

classname function, default for DCO objects