fesa-core-gsi  4.2.0
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)
 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...
 
virtual int getCycleSelectorId (const fesaGSI::Selector &selector)=0
 returns the SelectorID of the corresponding selector. More...
 
virtual bool containsValidCycleSelectorId (const fesaGSI::Selector &selector)=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...
 

Static Public Member Functions

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

virtual std::string translateCycleSelectorOldFormat1 (const std::string &cycleSelectorOldFormat1)=0
 translates a cycle-selector string of the old format to the current format (E.g. FAIR.USER.12:34) More...
 
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 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)
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.

std::string fesaGSI::GSICycleDescriptorWR::extractOldFormatBPID ( std::string  cycleSelectorOldFormat)
static

extracts the BPID from a cycleName of the old format

Returns
the BP ID as string
std::string fesaGSI::GSICycleDescriptorWR::extractOldFormatSEQID ( std::string  cycleSelectorOldFormat)
static

extracts the SEQ from a cycleName of the old format

Returns
the SEQ ID as string
int fesaGSI::GSICycleDescriptorWR::getCycleSelectorId ( const std::string &  timingSelectorName)

returns the SelectorID of the corresponding timingSelectorName.

Parameters
timingSelectorNamethe name of the requested timingSelector
Returns
timingSelector ID
virtual int fesaGSI::GSICycleDescriptorWR::getCycleSelectorId ( const fesaGSI::Selector &  selector)
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)

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

Returns
true, if valid
virtual std::string fesaGSI::GSICycleDescriptorWR::translateCycleSelectorOldFormat1 ( const std::string &  cycleSelectorOldFormat1)
protectedpure virtual

translates a cycle-selector string of the old format to the current format (E.g. FAIR.USER.12:34)

Parameters
cycleSelectorOldFormatcycle selector of the old format
Returns
cycleSelectorNewFormat

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

std::string fesaGSI::GSICycleDescriptorWR::translateCycleSelectorOldFormat2 ( const std::string &  cycleSelectorOldFormat2)
protected

translates a cycle-selector string of the old format to the current format (E.g. FAIR.SEQ.12)

Parameters
cycleSelectorOldFormatcycle selector of the old format
Returns
cycleSelectorNewFormat

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