class CPeriodicScheduler


Inheritance:


Public Methods

[more] CPeriodicScheduler(const CPeriodicScheduler* pSuperBlock, const CDSLibComponent* pContainer = NULL)
Copy-constructor.
[more] ~CPeriodicScheduler()
Destructor
[more]virtual std::string Class() const
Returns "CPeriodicScheduler"
[more]virtual CPeriodicScheduler* Clone( const CDSLibComponent* pContainer= NULL) const
Returns a new CPeriodicScheduler object copied from this one using the copy-constructor above.
[more]virtual bool DescendantOf(const std::string & strClassName) const
Returns if strClassName is "CPeriodicScheduler" or the name of one of its base classes.
[more]long long Period() const
Returns the execution period, in nanoseconds
[more]bool SetPeriod(long long)
Sets the execution period, in nanoseconds
[more]virtual std::string Value(const std::string & strValueName) const
Returns a string to be inserted in the generated code instead of a <value > template command.

Public Members

[more] Superblock that defines a periodic execution for all its contained blocks

Protected Methods

[more]virtual void GenerateCode(const std::string & strTemplatesPath, CCodeSection* pCodeSection) const
Makes this object and its contained objects generate code for the section in the arguments.


Inherited from CScheduler:

Public Methods

ovirtual bool AcceptsContainer(const CDSLibComponent* pContainer)
ovirtual bool AddComponent(CDSLibComponent* pComponent)
obool ContainsReader() const
obool ContainsWriter() const
ounsigned int CPU() const
ovirtual const std::string GlobalIdentifier() const
oint Priority() const
obool SetCPU(unsigned int uiCPU)
obool SetPriority(int iPriority)

Public Members

o Base class for schedulers, which are superblocks with an associated execution schedule.


Inherited from CSuperBlock:

Public Methods

obool AddInput(const std::string & strIdentifier, const std::string & strType = "float", unsigned int uiArrayLength = 0, bool bRead = false, bool bWrite = false)
obool AddInputs(unsigned int uiNumber, const std::string & strType = "float", unsigned int uiArrayLength = 0, bool bRead = false, bool bWrite = false)
obool AddOutput(const std::string & strIdentifier, const std::string & strType = "float", unsigned int uiArrayLength = 0, bool bRead = false, bool bWrite = false)
obool AddOutputs(unsigned int uiNumber, const std::string & strType = "float", unsigned int uiArrayLength = 0, bool bRead = false, bool bWrite = false)

Public Members

o Block whose operation is defined by its contained blocks


Inherited from CBlock:

Public Methods

oCBlockVariable* BlockVariable(const std::string & strIdentifier) const
oCBlockVariable* BlockVariable(unsigned int uIndex) const
oCInput* Input(const std::string & strName) const
oCInput* Input(unsigned int uIndex) const
ovirtual unsigned int NumberOfBlockVariables() const
ovirtual unsigned int NumberOfInputs() const
ovirtual unsigned int NumberOfOutputs() const
oCOutput* Output(const std::string & strName) const
oCOutput* Output(unsigned int uIndex) const
obool SchedulerContainsReader() const
obool SchedulerContainsWriter() const


Inherited from CDSLibComponent:

Public Methods

obool AllArrange()
ovoid AllGenerateCode(const std::string &strTemplatesPath, CCodeSection* pCodeSection) const
ovirtual bool AllRepeatedValue(const CDSLibComponent* pCaller, const std::string & strValueName, const std::string & strValue) const
ovoid AllReportMessages(CMessages* pMessagesReport)
oconst CDSLibComponent* Component(const std::string & strIdentifier, const std::string & strClass) const
oconst CDSLibComponentPointers& Components() const
oconst CDSLibComponent* Container( const std::string & strClass = "", unsigned int uSkip = 0) const
ovoid DeleteObjects()
oconst std::string& Identifier() const
oint ComponentIndex() const
oconst CMessages& Messages() const
ovirtual bool RepeatedValue(const std::string &, const std::string &) const
obool SetIdentifier(const std::string & strIdentifier)

Protected Methods

ovirtual void AddMessage(unsigned int uNumber)
ovirtual void Arrange()
oCDSLibComponentPointers& Components()
ovirtual void ComponentsGenerateCode(const std::string &strTemplatesPath, CCodeSection* pCodeSection) const
ostd::string LongLongToString(long long llNumber) const
oCMessages& Messages()
obool ParseTemplate(const std::string & strTemplatesPath, const std::string & strTemplate, CCodeSection* pOutputSection) const
ovoid SetContainer(const CDSLibComponent* pContainer)
olong long StringToLongLong(const std::string &strNumber) const
ostd::string DoubleToString(double dNumber) const


Documentation

o Superblock that defines a periodic execution for all its contained blocks
Superblock that defines a periodic execution for all its contained blocks

o CPeriodicScheduler(const CPeriodicScheduler* pSuperBlock, const CDSLibComponent* pContainer = NULL)
Copy-constructor. Copies all the attributes of CPeriodicScheduler and calls the copy-constructor of CScheduler.
Parameters:
pSuperBlock - Object to copy from.
pContainer - Container for this new object.

o ~CPeriodicScheduler()
Destructor

ovirtual std::string Class() const
Returns "CPeriodicScheduler"

ovirtual CPeriodicScheduler* Clone( const CDSLibComponent* pContainer= NULL) const
Returns a new CPeriodicScheduler object copied from this one using the copy-constructor above.
Parameters:
pContainer - Container for the new object.

ovirtual bool DescendantOf(const std::string & strClassName) const
Returns if strClassName is "CPeriodicScheduler" or the name of one of its base classes.
Parameters:
strClassName - Class name.

olong long Period() const
Returns the execution period, in nanoseconds

obool SetPeriod(long long)
Sets the execution period, in nanoseconds

ovirtual std::string Value(const std::string & strValueName) const
Returns a string to be inserted in the generated code instead of a <value > template command.
Parameters:
strValueName - Value of the "name" parameter of the template command.

ovirtual void GenerateCode(const std::string & strTemplatesPath, CCodeSection* pCodeSection) const
Makes this object and its contained objects generate code for the section in the arguments.
Parameters:
strTemplatesPath - Path of the folder containing the template files.
pCodeSection - Code section to be generated. It must already point to a CCodeSection object, which may be modified by adding new sections and lines to it.


This class has no child classes.
Author:
Ivan Martinez

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.