Inherited from CSuperBlock:

Public Methods

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

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

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

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

virtual std::string Class() const

CSuperBlock* Clone(const CDSLibComponent* pContainer = NULL) const

Public Members

Block whose operation is defined by its contained blocks

Protected Methods

virtual void GenerateCode(const std::string & strTemplatesPath, CCodeSection* pCodeSection) const

Inherited from CBlock:

Public Methods

CBlockVariable* BlockVariable(const std::string & strIdentifier) const

CBlockVariable* BlockVariable(unsigned int uIndex) const

CInput* Input(const std::string & strName) const

CInput* Input(unsigned int uIndex) const

virtual unsigned int NumberOfBlockVariables() const

virtual unsigned int NumberOfInputs() const

virtual unsigned int NumberOfOutputs() const

COutput* Output(const std::string & strName) const

COutput* Output(unsigned int uIndex) const

bool SchedulerContainsReader() const

bool SchedulerContainsWriter() const

Inherited from CDSLibComponent:

Public Methods

bool AllArrange()

void AllGenerateCode(const std::string &strTemplatesPath, CCodeSection* pCodeSection) const

virtual bool AllRepeatedValue(const CDSLibComponent* pCaller, const std::string & strValueName, const std::string & strValue) const

void AllReportMessages(CMessages* pMessagesReport)

const CDSLibComponent* Component(const std::string & strIdentifier, const std::string & strClass) const

const CDSLibComponentPointers& Components() const

const CDSLibComponent* Container( const std::string & strClass = "", unsigned int uSkip = 0) const

void DeleteObjects()

const std::string& Identifier() const

int ComponentIndex() const

const CMessages& Messages() const

virtual bool RepeatedValue(const std::string &, const std::string &) const

bool SetIdentifier(const std::string & strIdentifier)

Protected Methods

virtual void AddMessage(unsigned int uNumber)

virtual void Arrange()

CDSLibComponentPointers& Components()

virtual void ComponentsGenerateCode(const std::string &strTemplatesPath, CCodeSection* pCodeSection) const

std::string LongLongToString(long long llNumber) const

CMessages& Messages()

bool ParseTemplate(const std::string & strTemplatesPath, const std::string & strTemplate, CCodeSection* pOutputSection) const

void SetContainer(const CDSLibComponent* pContainer)

long long StringToLongLong(const std::string &strNumber) const

std::string DoubleToString(double dNumber) const

Documentation

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

Base class for schedulers, which are superblocks with an associated execution schedule. Schedulers must be the top-level blocks of any dynamic system, so they define the execution of every block contained by them.

CScheduler(const CScheduler* pSuperBlock, const CDSLibComponent* pContainer = NULL)

Copy-constructor. Copies all the attributes of CScheduler and calls the copy-constructor of CSuperBlock.

Parameters:

pSuperBlock - Object to copy from.
pContainer - Container for this new object.

virtual ~CScheduler()

Destructor

virtual bool AcceptsContainer(const CDSLibComponent* pContainer)

If the argument is a CDynamicSystem or any descendant class, sets the argument as the container and returns true. Otherwise, it generates the message NON_SUITABLE_CONTAINER_ERROR and return false.

Parameters:

pContainer - Container for this component.

virtual bool AddComponent(CDSLibComponent* pComponent)

If pComponent is a CInput, COutput, or any of their descendants, generates the message CANT_ADD_IO_TO_SCHEDULER_ERROR and returns false. Otherwise, calls AddComponent in CSuperBlock and returns the result.

Parameters:

pComponent - Component for this container.

bool ContainsReader() const

Returns if this scheduler contains CReader components

bool ContainsWriter() const

Returns if this scheduler contains CWriter components

unsigned int CPU() const

Returns the CPU where this scheduler's operations will be executed

virtual bool DescendantOf(const std::string & strClassName) const

Returns if strClassName is "CScheduler" or the name of one of its base classes.

Parameters:

strClassName - Class name.

virtual const std::string GlobalIdentifier() const

Redefines GlobalIdentifier() in CBlock so it returns Identifier() here

int Priority() const

Returns the priority of execution for this scheduler

bool SetCPU(unsigned int uiCPU)

Sets the CPU where this scheduler's operations will be executed.

Parameters:

uiCPU - CPU number.

bool SetPriority(int iPriority)

Sets the priority of execution for this scheduler.

Parameters:

iPriority - Priority.

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.

Parameters:

strValueName - Value of the "name" parameter of the template command.

Direct child classes:

CPeriodicScheduler

Author:

Ivan Martinez

Alphabetic index HTML hierarchy of classes or Java