Inherited from CBlock:

Public Methods

virtual bool AcceptsContainer(const CDSLibComponent* pContainer)

virtual bool AddComponent(CDSLibComponent* pComponent)

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

CBlockVariable* BlockVariable(unsigned int uIndex) const

virtual const std::string GlobalIdentifier() 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

Block whose operation can be freely written by the user in C

Block whose operation can be freely written by the user in C

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

Copy-constructor. Copies all the attributes of CFunction and calls the copy-constructor of CBlock

virtual ~CFunction()

Destructor

bool AddBlockVariable( const std::string &, Identifier of the block variable* / const std::string & = "float", Type of the block variable* / unsigned int = 0, bool = false, bool = false )

Adds a block variable to this block

Parameters:

int - If it is 0 or 1, then the variable is of simple type. If it's 2 or more, then it will be an array of the type, and this argument sets the length of the array
bool - Sets if the variable can be read from outside the dynamic system with a CReader
bool - Sets if the variable can be written from outside the dynamic system with a CWriter

bool AddBlockVariables( unsigned int, const std::string & = "float", Type of the block variables* / unsigned int = 0, bool = false, bool = false )

Adds block variables to this block

Parameters:

int - Number of variables to be added. The variables will be added one by one with the identifier "blockvar<number>", being <number> the already existing number of block variables each time
int - If it is 0 or 1, then the variables are of simple type. If it's 2 or more, then every variable will be an array of the type, and this argument sets the length of the arrays
bool - Sets if the variables can be read from outside the dynamic system with a CReader
bool - Sets if the variables can be written from outside the dynamic system with a CWriter

bool AddInput( const std::string &, Identifier of the input* / const std::string & = "float", Type of the input* / unsigned int = 0, bool = false, bool = false )

Adds an input to this block

Parameters:

int - If it is 0 or 1, then the input is of simple type. If it's 2 or more, then it will be an array of the type, and this argument sets the length of the array
bool - Sets if the input can be read from outside the dynamic system with a CReader
bool - Sets if the input can be written from outside the dynamic system with a CWriter

bool AddInputs( unsigned int, const std::string & = "float", Type of the inputs* / unsigned int = 0, bool = false, bool = false )

Adds inputs to this block

Parameters:

int - Number of inputs to be added. The inputs will be added one by one with the identifier "input<number>", being <number> the already existing number of inputs each time
int - If it is 0 or 1, then the inputs are of simple type. If it's 2 or more, then every input will be an array of the type, and this argument sets the length of the arrays
bool - Sets if the inputs can be read from outside the dynamic system with a CReader
bool - Sets if the outputs can be written from outside the dynamic system with a CWriter

bool AddOutput( const std::string &, Identifier of the output* / const std::string & = "float", Type of the output* / unsigned int = 0, bool = false, bool = false )

Adds an output to this block

Parameters:

int - If it is 0 or 1, then the output is of simple type. If it's 2 or more, then it will be an array of the type, and this argument sets the length of the array
bool - Sets if the output can be read from outside the dynamic system with a CReader
bool - Sets if the output can be written from outside the dynamic system with a CWriter

const std::string& AfterRunCode() const

Returns the cleaning-up code to be executed after finishing the realtime execution of the system

const std::string& BeforeRunCode() const

Returns the initializing code to be executed before starting the realtime execution of the system

virtual std::string Class() const

Returns "CFuncion"

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

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

virtual bool DescendantOf( const std::string & Class name* / ) const

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

const std::string& RunCode() const

Returns the code to be executed in every realtime iteration of the system

bool SetAfterRunCode( const std::string & Code to be executed. Lines should finish with "\n"* / )

Sets the cleaning-up code to be executed after finishing the realtime execution of the system

bool SetBeforeRunCode( const std::string & Code to be executed. Lines should finish with "\n"* / )

Sets the initializing code to be executed before starting the realtime execution of the system

bool SetRunCode( const std::string & Code to be executed. Lines should finish with "\n"* / )

Sets the code to be executed in every realtime iteration of the system

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

Makes this object and its contained objects generate code for the section in the arguments

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