fesa-core-gsi  4.2.0
fesaGSI::GSICycleDescriptorWRSequence Class Reference

This TimingDescriptor is used to handle the WR timing + multiplexing per sequence. More...

#include <GSICycleDescriptorWRSequence.h>

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

Public Member Functions

 GSICycleDescriptorWRSequence (const std::string &timingDomain, const std::string &timingCriterion, uint32_t multiplexingDepth)
 Constructor. More...
 
MuxCriterionWR::MuxCriterionWR getMultiplexingCriterion ()
 returns the WR multiplexing criterion used for this CycleDescriptor More...
 
std::string translateCycleSelectorOldFormat1 (const std::string &cycleSelectorOldFormat1)
 
int getCycleSelectorId (const fesaGSI::Selector &selector)
 returns the SelectorID of the corresponding timingSelectorName. More...
 
bool containsValidCycleSelectorId (const fesaGSI::Selector &selector)
 returns true, if the selector contains a valid slot-id '0' is considered as 'valid id' More...
 
- Public Member Functions inherited from fesaGSI::GSICycleDescriptorWR
 GSICycleDescriptorWR (const std::string &timingDomain, const std::string &timingCriterion)
 Constructor. More...
 
virtual ~GSICycleDescriptorWR ()
 Destructor.
 
bool isValidCycleSelector (const std::string &timingSelectorName)
 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...
 
int getCycleSelectorId (const std::string &timingSelectorName)
 returns the SelectorID of the corresponding timingSelectorName. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fesaGSI::GSICycleDescriptorWR
static std::string extractOldFormatBPID (std::string cycleSelectorOldFormat)
 extracts the BPID from a cycleName of the old format More...
 
static std::string extractOldFormatSEQID (std::string cycleSelectorOldFormat)
 extracts the SEQ from a cycleName of the old format More...
 
- Protected Member Functions inherited from fesaGSI::GSICycleDescriptorWR
std::string translateCycleSelectorOldFormat2 (const std::string &cycleSelectorOldFormat2)
 translates a cycle-selector string of the old format to the current format (E.g. FAIR.SEQ.12) More...
 

Detailed Description

This TimingDescriptor is used to handle the WR timing + multiplexing per sequence.

Constructor & Destructor Documentation

fesaGSI::GSICycleDescriptorWRSequence::GSICycleDescriptorWRSequence ( const std::string &  timingDomain,
const std::string &  timingCriterion,
uint32_t  multiplexingDepth 
)

Constructor.

Parameters
timingDomainDomain where the timing is used
timingCriterioncriterion for which the data can be multiplexed. For example USER (VA) creates a WR-CycleDescriptor which handles sequences

Member Function Documentation

bool fesaGSI::GSICycleDescriptorWRSequence::containsValidCycleSelectorId ( const fesaGSI::Selector &  selector)
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

Implements fesaGSI::GSICycleDescriptorWR.

int fesaGSI::GSICycleDescriptorWRSequence::getCycleSelectorId ( const fesaGSI::Selector &  selector)
virtual

returns the SelectorID of the corresponding timingSelectorName.

Parameters
timingSelectorNamethe name of the requested timingSelector
Returns
timingSelector ID

Implements fesaGSI::GSICycleDescriptorWR.

MuxCriterionWR::MuxCriterionWR fesaGSI::GSICycleDescriptorWRSequence::getMultiplexingCriterion ( )
virtual

returns the WR multiplexing criterion used for this CycleDescriptor

Returns
WR multiplexing criterion

Implements fesaGSI::GSICycleDescriptorWR.

std::string fesaGSI::GSICycleDescriptorWRSequence::translateCycleSelectorOldFormat1 ( const std::string &  cycleSelectorOldFormat1)
virtual

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