Inherited from CVariable:

Public Methods

bool AcceptsContainer( const CDSLibComponent* Container for this component* / )

unsigned int ArrayLength() const

const std::string ExternalIdentifier() const

bool IsArray() const

bool Read() const

bool SetArrayLength( unsigned int )

bool SetRead(bool)

void SetType(const std::string &)

bool SetWrite(bool)

virtual const std::string Type() const

bool Write() const

Public Members

Base class for all the others that define variables that may be used in a dynamic system

Inherited from CDSLibComponent:

Public Methods

virtual bool AddComponent(CDSLibComponent* pComponent)

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

Class that defines input variables for blocks

Class that defines input variables for blocks

CInput( const std::string &, Identifier for the output variable* / const std::string &, Type for the output variable* / unsigned int = 0, bool = false, bool = false )

Constructor

Parameters:

int - Array length for the output variable
bool - Sets if the variable can be read from outside the dynamic system
bool - Sets if the variable can be written from outside the dynamic system

CInput( const CInput* , Object to copy from* / const CDSLibComponent* = NULL Container for this new object* / )

Copy-constructor. Copies all the attributes of COutput (except the container) and calls the copy-constructor of CVariable

~CInput()

Destructor

std::string Class() const

Returns "CInput"

virtual CInput* Clone( const CDSLibComponent* = NULL Container for the new object* / ) const

Returns a new CInput object copied from this one using the copy-constructor above

bool Connect(COutput* )

Tries to connect this input to the argument. There are three possible situations: - This input and the argument are in top level blocks under different schedulers. The connection type is set to SCHEDULER_SUPERBLOCK_OUTPUT and the indexes for source scheduler, source block and source variable are set to point to the argument. Returns true. - This input's block and the argument's block are in the same superblock. The connection type is set to OUTPUT, and the indexes for the source scheduler, source block and source variable are set to point to the argument. The call returns true. - In any other case, the ILEGAL_CONNECTION_ERROR message es generated and returs false

bool Connect(CInput* )

Tries to connect this input to the argument. There are three possible situations: - This input is in a block and the argument is in the inmediate superblock. The connection type is set to SUPERBLOCK_INPUT and the indexes for the source scheduler, source block and source variable are set to point to the argument. Returns true. - This input is in a superblock and the argument is in a block directly contained by the superblock. In this case the connection is tried in the reverse order, Connect(...) is called in the argument passing this object as its argument. Returns the result of the call. - In any other case, the ILEGAL_CONNECTION_ERROR message es generated and returs false

bool Connected() const

Returns if this input has a value source. Variables who are the value source of other variables are considered as not connected

bool ConnectedToShared() const

Returns if this input is connected to an output under a different scheduler. Concurrent access protections will be generated in that case

enum EConnectionType ConnectionType() const

Returns the way the output is connected

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

Returns TRUE if the argument is "CInput" or one of its base classes, otherwise FALSE

virtual unsigned int SourceBlockIndex() const

Returns the index of the block containing the source variable in the list of components of its container

virtual unsigned int SourceSchedulerIndex() const

Returns the index of the scheduler of the block containing the source variable in the list of components of its container

virtual unsigned int SourceVariableIndex() const

Returns the index of the source variable in the list of components of its container

virtual std::string Value( const std::string & Value of the "name" parameter of the template command* / ) const

Returns a string to be inserted in the generated code instead of a <value > template command 

const CVariable* ValueSource() const

Returns the variable from which this input gets its value when it is connected, NULL otherwise

virtual void GenerateCode( const std::string &, Path to the template files to be parsed* / CCodeSection* 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* / ) const

Generates code for the section in the arguments, in this object and its contained objects

void SetConnectionType( enum EConnectionType )

Sets the way the output is connected

Parameters:

EConnectionType - Connection type

void SetSourceBlockIndex( unsigned int )

Sets the index of the block containing the source variable in the list of components of its container

Parameters:

int - Index of the block it its list of components

void SetSourceSchedulerIndex( unsigned int )

Sets the index of the scheduler of the block containing the source variable in the list of components of its container

Parameters:

int - Index of the scheduler in its list of components

void SetSourceVariableIndex( unsigned int )

Sets the index of the source variable in the list of components of its container

Parameters:

int - Index of the source variable in its list of components