class CVariable


Inheritance:


Public Methods

[more] CVariable(const CVariable* , const CDSLibComponent* = NULL)
Copy-constructor.
[more] ~CVariable()
Destructor
[more]bool AcceptsContainer( const CDSLibComponent* Container for this component* / )
If the argument is an instance of CBlock or any descendant class, sets the argument as the container and returns true.
[more]unsigned int ArrayLength() const
Returns the length of the array
[more]virtual bool DescendantOf(const std::string &) const
Returns if the argument is "CVariable" or the name of one of its base classes
[more]const std::string ExternalIdentifier() const
Identifier of the variable outside its block
[more]bool IsArray() const
Returns if the variable is an array
[more]bool Read() const
Returns if the variable can be read from outside the dynamic system
[more]bool SetArrayLength( unsigned int )
If the argument is 0 or 1, then the dynamic system variable is of simple type.
[more]bool SetRead(bool)
Sets if the variable con be read from outside the dynamic system
[more]void SetType(const std::string &)
Sets the type of the variable in the dynamic system
[more]bool SetWrite(bool)
Sets if the variable can be written from outside the dynamic system
[more]virtual const std::string Type() const
Returns the type of the variable in the dynamic system
[more]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 
[more]bool Write() const
Returns if the variable can be written from outside the dynamic system

Public Members

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


Inherited from CDSLibComponent:

Public Methods

ovirtual bool AddComponent(CDSLibComponent* pComponent)
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)
ovirtual std::string Class() const
ovirtual CDSLibComponent* Clone( const CDSLibComponent* pContainer = NULL) const
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
ovirtual void GenerateCode(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 Base class for all the others that define variables that may be used in a dynamic system
Base class for all the others that define variables that may be used in a dynamic system

o CVariable(const CVariable* , const CDSLibComponent* = NULL)
Copy-constructor. Copies all the attributes of CVariable and calls the copy-constructor of CDSLibComponent

o ~CVariable()
Destructor

obool AcceptsContainer( const CDSLibComponent* Container for this component* / )
If the argument is an instance of CBlock or any descendant class, sets the argument as the container and returns true. Otherwise, it generates the message NON_SUITABLE_CONTAINER_ERROR and retun false

ounsigned int ArrayLength() const
Returns the length of the array

ovirtual bool DescendantOf(const std::string &) const
Returns if the argument is "CVariable" or the name of one of its base classes

oconst std::string ExternalIdentifier() const
Identifier of the variable outside its block

obool IsArray() const
Returns if the variable is an array

obool Read() const
Returns if the variable can be read from outside the dynamic system

obool SetArrayLength( unsigned int )
If the argument is 0 or 1, then the dynamic system variable is of simple type. If it's 2 or more, then it will be an array of the type, and the argument will be the length of the array
Parameters:
int - Array length

obool SetRead(bool)
Sets if the variable con be read from outside the dynamic system

ovoid SetType(const std::string &)
Sets the type of the variable in the dynamic system

obool SetWrite(bool)
Sets if the variable can be written from outside the dynamic system

ovirtual const std::string Type() const
Returns the type of the variable in the dynamic system

ovirtual 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 

obool Write() const
Returns if the variable can be written from outside the dynamic system


Direct child classes:
COutput
CInput
CBlockVariable
Author:
Ivan Martinez

Alphabetic index HTML hierarchy of classes or Java



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