Inheritance:
Public Methods
-
CRTLFifoReader( const CRTLFifoReader* , Object to copy from* / const CDSLibComponent* = NULL Container for this new object* / )
- Copy-constructor.
-
~CRTLFifoReader()
- Destructor
-
virtual std::string Class() const
- Returns "CRTLFifoReader
-
virtual CRTLFifoReader* Clone(const CDSLibComponent* = NULL) const
- Returns a new CRTLFifoReader object copied from this one using the copy-constructor above
-
virtual bool DescendantOf( const std::string & Class name* / ) const
- Returns if the argument is "CRTLFifoReader" or the name of one of its base classes
-
unsigned int Length() const
- Returns the number of positions in the FIFO's buffer.
-
unsigned int Number() const
- Returns the RTL FIFO number, corresponding to the device file /dev/rtf<number>
-
bool Sampling() const
- Returns if the FIFO's relative sampling rate is less than 1
-
float SamplingRate() const
- Returns the FIFO's sampling rate, relative to the scheduler's execution rate
-
bool SetLength( unsigned int )
- Sets the number of positions in the FIFO's buffer.
-
bool SetNumber( unsigned int )
- Sets the RTL FIFO number, corresponding to the device file /dev/rtf<number>
-
bool SetSamplingRate( float )
- Sets the FIFO's sampling rate, relative to the scheduler's execution rate
-
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
-
RTL FIFO to read variables of the dynamic system
Protected Methods
-
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
Inherited from CReader:
Public Methods
-
bool AcceptsContainer(const CDSLibComponent* )
Public Members
-
Base class for all the others that define communication mechanisms from the dynamic system to the external world
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
RTL FIFO to read variables of the dynamic system
- RTL FIFO to read variables of the dynamic system
CRTLFifoReader( const CRTLFifoReader* , Object to copy from* / const CDSLibComponent* = NULL Container for this new object* / )
- Copy-constructor. Copies all the attributes of CRTLFifoWriter and
calls the copy-constructor of CReader
~CRTLFifoReader()
- Destructor
virtual std::string Class() const
- Returns "CRTLFifoReader
virtual CRTLFifoReader* Clone(const CDSLibComponent* = NULL) const
- Returns a new CRTLFifoReader object copied from this one using
the copy-constructor above
virtual bool DescendantOf( const std::string & Class name* / ) const
- Returns if the argument is "CRTLFifoReader" or the name of one of
its base classes
unsigned int Length() const
- Returns the number of positions in the FIFO's buffer. Every position
contains a sample of all the readable variables
unsigned int Number() const
- Returns the RTL FIFO number, corresponding to the device file
/dev/rtf<number>
bool Sampling() const
- Returns if the FIFO's relative sampling rate is less than 1
float SamplingRate() const
- Returns the FIFO's sampling rate, relative to the scheduler's
execution rate
bool SetLength( unsigned int )
- Sets the number of positions in the FIFO's buffer. Every position
contains a sample of all the readable variables
- Parameters:
- int - Number of positions in the buffer
bool SetNumber( unsigned int )
- Sets the RTL FIFO number, corresponding to the device file
/dev/rtf<number>
- Parameters:
- int - RTL FIFO number
bool SetSamplingRate( float )
- Sets the FIFO's sampling rate, relative to the scheduler's
execution rate
- Parameters:
- float - Relative sampling rate, from 0 to 1
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
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
- 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++.