class CDynamicSystem


Inheritance:


Public Methods

[more] CDynamicSystem( const CDynamicSystem* Object to copy from* / )
Copy-constructor.
[more]virtual ~CDynamicSystem()
Destructor
[more]virtual bool AcceptsContainer(const CDSLibComponent*)
Generates the NON_SUITABLE_CONTAINER_ERROR message and retuns false
[more]bool ArrangeAll()
If there are no messages in this object, calls AllArrange().
[more]virtual std::string Class() const
Returns "CDynamicSystem"
[more]virtual CDynamicSystem* Clone( const CDSLibComponent* = NULL Container for the new object* / ) const
Returns a new CDynamicSystem object copied from this one, using the copy-constructor above
[more]virtual bool DescendantOf( const std::string & Class name to check* / ) const
Returns if the argument is "CDynamicSystem" or the name of one of its base classes
[more]virtual void GenerateCode( const std::string &, Path to the template files to be parsed* / std::ostream & STL ostream where the generated code will be written* / ) const
Performs a code generation for the whole dynamic system
[more]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
[more]std::string Includes() const
Returns additional include directives for the realtime module
[more]std::string MakefileBeforeCompilation() const
Returns additional makefile commands to be performed before compilation
[more]std::string MakefileInstallCommands() const
Returns additional makefile commands to be performed when doing "make install"
[more]std::string MakefileRemoveCommands() const
Returns additional makefile commands to be performed when doing "make remove"
[more]long long RTClockResolution() const
Returns the resolution of the realtime clock in nanoseconds
[more]bool SetIncludes(const std::string &)
Sets additional include directives for the realtime module
[more]bool SetMakefileBeforeCompilation(const std::string &)
Sets additional makefile commands to be performed before compilation
[more]bool SetMakefileInstallCommands(const std::string &)
Sets additional makefile commands to be performed when doing "make install"
[more]bool SetMakefileRemoveCommands(const std::string &)
Sets additional makefile commands to be performed when doing "make remove"
[more]bool SetRTClockResolution( long long )
Sets the resolution of the realtime clock in nanoseconds
[more]bool SetTime( long long )
Sets the maximum execution time for the dynamic system in nanoseconds
[more]long long Time() const
Returns the maximum execution time for the dynamyc system in nanoseconds
[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 

Public Members

[more] This is the root container for a dynamic-system definition.


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)
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
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 This is the root container for a dynamic-system definition.
This is the root container for a dynamic-system definition. A dynamic system definition consists of objects containing other objects in a tree structure. This object also defines some general parameters for the whole system

o CDynamicSystem( const CDynamicSystem* Object to copy from* / )
Copy-constructor. Copies all the attributes of CDynamicSystem and calls the copy-constructor of CDSLibComponent

ovirtual ~CDynamicSystem()
Destructor

ovirtual bool AcceptsContainer(const CDSLibComponent*)
Generates the NON_SUITABLE_CONTAINER_ERROR message and retuns false

obool ArrangeAll()
If there are no messages in this object, calls AllArrange(). Returns if any message has been generated and the top-down arrange stopped somewhere

ovirtual std::string Class() const
Returns "CDynamicSystem"

ovirtual CDynamicSystem* Clone( const CDSLibComponent* = NULL Container for the new object* / ) const
Returns a new CDynamicSystem object copied from this one, using the copy-constructor above

ovirtual bool DescendantOf( const std::string & Class name to check* / ) const
Returns if the argument is "CDynamicSystem" or the name of one of its base classes

ovirtual void GenerateCode( const std::string &, Path to the template files to be parsed* / std::ostream & STL ostream where the generated code will be written* / ) const
Performs a code generation for the whole dynamic system

ovirtual 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

ostd::string Includes() const
Returns additional include directives for the realtime module

ostd::string MakefileBeforeCompilation() const
Returns additional makefile commands to be performed before compilation

ostd::string MakefileInstallCommands() const
Returns additional makefile commands to be performed when doing "make install"

ostd::string MakefileRemoveCommands() const
Returns additional makefile commands to be performed when doing "make remove"

olong long RTClockResolution() const
Returns the resolution of the realtime clock in nanoseconds

obool SetIncludes(const std::string &)
Sets additional include directives for the realtime module

obool SetMakefileBeforeCompilation(const std::string &)
Sets additional makefile commands to be performed before compilation

obool SetMakefileInstallCommands(const std::string &)
Sets additional makefile commands to be performed when doing "make install"

obool SetMakefileRemoveCommands(const std::string &)
Sets additional makefile commands to be performed when doing "make remove"

obool SetRTClockResolution( long long )
Sets the resolution of the realtime clock in nanoseconds
Parameters:
long - Quantum time in nanoseconds

obool SetTime( long long )
Sets the maximum execution time for the dynamic system in nanoseconds
Parameters:
long - Time in nanoseconds

olong long Time() const
Returns the maximum execution time for the dynamyc system in nanoseconds

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 


This class has no child classes.
Author:
Ivan Martinez

Alphabetic index HTML hierarchy of classes or Java



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