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 block variables for blocks

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

Constructor.

Parameters:

strIdentifier - Identifier for the block variable
strType - Type for the block variable
uiArrayLength - Array length for the block variable
bRead - Sets if the variable can be read from outside the dynamic system
bWrite - Sets if the variable can be written from outside the dynamic system

CBlockVariable(const CBlockVariable* pVariable, const CDSLibComponent* pContainer = NULL)

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

Parameters:

pVariable - Object to copy from
pContainer - Container for this new object

~CBlockVariable()

Destructor

virtual std::string Class() const

Returns "CBlockVariable"

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

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

Parameters:

pContainer - Container for the new object

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

Returns if the argument is "CBlockVariable" or the name of one of its base classes.

Parameters:

strClassName - Class name

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 - "name" argument of the template command

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

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

Parameters:

strTemplatesPath - Path to the template files to be parsed
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.

Alphabetic index HTML hierarchy of classes or Java