fesa-core-gsi  5.0.1
fesaGSI::GSICycleDescriptorWR Class Referenceabstract

This Timing Descriptor is used to handle the WR timing. More...

#include <GSICycleDescriptorWR.h>

Inheritance diagram for fesaGSI::GSICycleDescriptorWR:
fesaGSI::GSICycleDescriptorWRProcess fesaGSI::GSICycleDescriptorWRSequence

Public Member Functions

 GSICycleDescriptorWR (const std::string &timingDomain, const std::string &timingCriterion)
 Constructor. More...
 
virtual ~GSICycleDescriptorWR ()
 Destructor.
 
bool isValidCycleSelector (const std::string &timingSelectorName) const
 Checks, if the given timingSelectorName is part of this TimingDescriptor. More...
 
const std::string getCycleSelectorName (int timingSelectorID)
 returns the SelectorName of the corresponding timingSelectorID. More...
 
int32_t getCycleSelectorId (const std::string &timingSelectorName) const
 returns the SelectorID of the corresponding timingSelectorName. More...
 
virtual int32_t getCycleSelectorId (const fesaGSI::Selector &selector) const =0
 returns the SelectorID of the corresponding selector. More...
 
virtual bool containsValidCycleSelectorId (const fesaGSI::Selector &selector) const =0
 returns true, if the selector contains a valid slot-id '0' is considered as 'valid id' More...
 
virtual
MuxCriterionWR::MuxCriterionWR 
getMultiplexingCriterion ()=0
 returns the WR multiplexing criterion used for this CycleDescriptor More...
 

Detailed Description

This Timing Descriptor is used to handle the WR timing.

Constructor & Destructor Documentation

fesaGSI::GSICycleDescriptorWR::GSICycleDescriptorWR ( const std::string &  timingDomain,
const std::string &  timingCriterion 
)

Constructor.

Parameters
timingDomainDomain where the timing is used
timingCriterioncriterion for which the data can be multiplexed. For example USER (VA)

Member Function Documentation

virtual bool fesaGSI::GSICycleDescriptorWR::containsValidCycleSelectorId ( const fesaGSI::Selector &  selector) const
pure virtual

returns true, if the selector contains a valid slot-id '0' is considered as 'valid id'

Parameters
selectorselector for which the id is checked
Returns
true if exists

Implemented in fesaGSI::GSICycleDescriptorWRProcess, and fesaGSI::GSICycleDescriptorWRSequence.

int32_t fesaGSI::GSICycleDescriptorWR::getCycleSelectorId ( const std::string &  timingSelectorName) const

returns the SelectorID of the corresponding timingSelectorName.

Parameters
timingSelectorNamethe name of the requested timingSelector
Returns
timingSelector ID
virtual int32_t fesaGSI::GSICycleDescriptorWR::getCycleSelectorId ( const fesaGSI::Selector &  selector) const
pure virtual

returns the SelectorID of the corresponding selector.

Parameters
selectorselector for which the id is requested
Returns
id

Implemented in fesaGSI::GSICycleDescriptorWRProcess, and fesaGSI::GSICycleDescriptorWRSequence.

const std::string fesaGSI::GSICycleDescriptorWR::getCycleSelectorName ( int  timingSelectorID)

returns the SelectorName of the corresponding timingSelectorID.

Parameters
timingSelectorIDthe ID of the requested timingSelector
Returns
timingSelectorName
virtual MuxCriterionWR::MuxCriterionWR fesaGSI::GSICycleDescriptorWR::getMultiplexingCriterion ( )
pure virtual

returns the WR multiplexing criterion used for this CycleDescriptor

Returns
WR multiplexing criterion

Implemented in fesaGSI::GSICycleDescriptorWRProcess, and fesaGSI::GSICycleDescriptorWRSequence.

bool fesaGSI::GSICycleDescriptorWR::isValidCycleSelector ( const std::string &  timingSelectorName) const

Checks, if the given timingSelectorName is part of this TimingDescriptor.

Returns
true, if valid

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