class CRTLFifoReader


Inheritance:


Public Methods

[more] CRTLFifoReader( const CRTLFifoReader* , Object to copy from* / const CDSLibComponent* = NULL Container for this new object* / )
Copy-constructor.
[more] ~CRTLFifoReader()
Destructor
[more]virtual std::string Class() const
Returns "CRTLFifoReader
[more]virtual CRTLFifoReader* Clone(const CDSLibComponent* = NULL) const
Returns a new CRTLFifoReader object copied from this one using the copy-constructor above
[more]virtual bool DescendantOf( const std::string & Class name* / ) const
Returns if the argument is "CRTLFifoReader" or the name of one of its base classes
[more]unsigned int Length() const
Returns the number of positions in the FIFO's buffer.
[more]unsigned int Number() const
Returns the RTL FIFO number, corresponding to the device file /dev/rtf<number>
[more]bool Sampling() const
Returns if the FIFO's relative sampling rate is less than 1
[more]float SamplingRate() const
Returns the FIFO's sampling rate, relative to the scheduler's execution rate
[more]bool SetLength( unsigned int )
Sets the number of positions in the FIFO's buffer.
[more]bool SetNumber( unsigned int )
Sets the RTL FIFO number, corresponding to the device file /dev/rtf<number>
[more]bool SetSamplingRate( float )
Sets the FIFO's sampling rate, relative to the scheduler's execution rate
[more]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] RTL FIFO to read variables of the dynamic system

Protected Methods

[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
Makes this object and its contained objects generate code for the section in the arguments


Inherited from CReader:

Public Methods

obool AcceptsContainer(const CDSLibComponent* )

Public Members

o Base class for all the others that define communication mechanisms from the dynamic system to the external world


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 RTL FIFO to read variables of the dynamic system
RTL FIFO to read variables of the dynamic system

o 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

o ~CRTLFifoReader()
Destructor

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

ovirtual CRTLFifoReader* Clone(const CDSLibComponent* = NULL) const
Returns a new CRTLFifoReader object copied from this one using the copy-constructor above

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

ounsigned int Length() const
Returns the number of positions in the FIFO's buffer. Every position contains a sample of all the readable variables

ounsigned int Number() const
Returns the RTL FIFO number, corresponding to the device file /dev/rtf<number>

obool Sampling() const
Returns if the FIFO's relative sampling rate is less than 1

ofloat SamplingRate() const
Returns the FIFO's sampling rate, relative to the scheduler's execution rate

obool 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

obool SetNumber( unsigned int )
Sets the RTL FIFO number, corresponding to the device file /dev/rtf<number>
Parameters:
int - RTL FIFO number

obool SetSamplingRate( float )
Sets the FIFO's sampling rate, relative to the scheduler's execution rate
Parameters:
float - Relative sampling rate, from 0 to 1

ostd::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 

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
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++.