LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::ioHandler Class Reference
[Storable Interface]

Input/output handlers. More...

#include <ltiIoHandler.h>

Inheritance diagram for lti::ioHandler:
Inheritance graph
[legend]
Collaboration diagram for lti::ioHandler:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ioHandler ()
 ioHandler (const ioHandler &other)
virtual ~ioHandler ()
virtual const char * getTypeName () const
ioHandlercopy (const ioHandler &other)
virtual ioHandlerclone () const =0
virtual void use (std::ostream &aStream)=0
virtual void use (std::istream &aStream)=0
virtual bool writeBegin ()
virtual bool writeEnd ()
virtual bool readBegin ()
virtual bool readEnd ()
virtual bool writeSymbol (const std::string &data)=0
virtual bool writeComment (const std::string &data)=0
virtual bool writeComment (const char *data)=0
virtual bool readSymbol (std::string &data)=0
virtual bool trySymbol (const std::string &data)=0
virtual bool tryBegin ()=0
virtual bool tryEnd ()=0
virtual bool writeSpaces (const int &s=1)=0
virtual bool writeEOL ()=0
virtual bool writeKeyValueSeparator ()=0
virtual bool writeDataSeparator ()=0
virtual bool readKeyValueSeparator ()=0
virtual bool readDataSeparator ()=0
virtual const int & getLevel () const
virtual bool restoreLevel ()=0
virtual void resetLevel (const int &theLevel=0)
write members



virtual bool write (const std::string &data)=0
virtual bool write (const char *data)=0
virtual bool write (const double &data)=0
virtual bool write (const float &data)=0
virtual bool write (const int &data)=0
virtual bool write (const unsigned int &data)=0
virtual bool write (const char &data)=0
virtual bool write (const byte &data)=0
virtual bool write (const ubyte &data)=0
virtual bool write (const bool &data)=0
virtual bool write (const long &data)=0
virtual bool write (const unsigned long &data)=0
virtual bool write (const short &data)=0
virtual bool write (const unsigned short &data)=0



virtual bool write (const std::string &name, const std::string &data)
virtual bool write (const std::string &name, const char *data)
virtual bool write (const std::string &name, const double &data)
virtual bool write (const std::string &name, const float &data)
virtual bool write (const std::string &name, const int &data)
virtual bool write (const std::string &name, const unsigned int &data)
virtual bool write (const std::string &name, const char &data)
virtual bool write (const std::string &name, const byte &data)
virtual bool write (const std::string &name, const ubyte &data)
virtual bool write (const std::string &name, const bool &data)
virtual bool write (const std::string &name, const long &data)
virtual bool write (const std::string &name, const unsigned long &data)
virtual bool write (const std::string &name, const short &data)
virtual bool write (const std::string &name, const unsigned short &data)
virtual bool read (const std::string &name, std::string &data)
virtual bool read (const std::string &name, double &data)
virtual bool read (const std::string &name, float &data)
virtual bool read (const std::string &name, int &data)
virtual bool read (const std::string &name, unsigned int &data)
virtual bool read (const std::string &name, char &data)
virtual bool read (const std::string &name, byte &data)
virtual bool read (const std::string &name, ubyte &data)
virtual bool read (const std::string &name, bool &data)
virtual bool read (const std::string &name, long &data)
virtual bool read (const std::string &name, unsigned long &data)
virtual bool read (const std::string &name, short &data)
virtual bool read (const std::string &name, unsigned short &data)
read members



virtual bool read (std::string &data)=0
virtual bool read (double &data)=0
virtual bool read (float &data)=0
virtual bool read (int &data)=0
virtual bool read (unsigned int &data)=0
virtual bool read (char &data)=0
virtual bool read (byte &data)=0
virtual bool read (ubyte &data)=0
virtual bool read (bool &data)=0
virtual bool read (long &data)=0
virtual bool read (unsigned long &data)=0
virtual bool read (short &data)=0
virtual bool read (unsigned short &data)=0
Error Report



virtual const char * getStatusString () const
virtual void setStatusString (const char *msg) const
virtual void setStatusString (const std::string &msg) const
virtual void appendStatusString (const char *msg) const
virtual void appendStatusString (const std::string &msg) const
virtual void appendStatusString (const int &msg) const
virtual void appendStatusString (const double &msg) const
virtual void appendContextStatus () const

Protected Attributes

int level

Detailed Description

Input/output handlers.

The ioHandler classes offer an abstract interface for the functor parameters and other lti::ioObject classes to read() and write() them in different formats.

The LTI-Lib standard ioHandler is the lti::lispStreamHandler, which uses a LISP-similar syntax to write and read data from streams. To save space and time while serializing objects, you can use the lti::binaryStreamHandler.

All ioHandlers are used as wrappers for std::istreams or std::ostreams objects. Therefore, the abstract interface provides the virtual methods use() to indicate which stream has to be used.


Constructor & Destructor Documentation

lti::ioHandler::ioHandler (  ) 

default constructor

lti::ioHandler::ioHandler ( const ioHandler other  ) 

copy constructor

virtual lti::ioHandler::~ioHandler (  )  [virtual]

destructor


Member Function Documentation

virtual void lti::ioHandler::appendContextStatus (  )  const [virtual]

Append contextual information.

This function should help the users to find errors in their files. It just inserts some contextual information into the status string to help localizing wrong data.

It is useful for streams that can be edited by hand, because the users will make errors!

The default behaviour does nothing.

Reimplemented in lti::lispStreamHandler.

Referenced by lti::read().

virtual void lti::ioHandler::appendStatusString ( const double &  msg  )  const [virtual]

append a double value to the current status string.

Take care to reset the status string by calling setStatusString() for each call of an apply() or similar method. appendStatusString() should only be used after setStatusString() has been called.

Parameters:
msg double value to be appended to the current status string.

Note that the change of the status string is not considered as a change in the functor status.

virtual void lti::ioHandler::appendStatusString ( const int &  msg  )  const [virtual]

append an integer value to the current status string.

Take care to reset the status string by calling setStatusString() for each call of an apply() or similar method. appendStatusString() should only be used after setStatusString() has been called.

Parameters:
msg integer value to be appended to the current status string.

Note that the change of the status string is not considered as a change in the functor status.

virtual void lti::ioHandler::appendStatusString ( const std::string &  msg  )  const [virtual]

append a message to the current status string.

Take care to reset the status string by calling setStatusString() for each call of an apply() or similar method. appendStatusString() should only be used after setStatusString() has been called.

Parameters:
msg message to be appended to the current status string.

Note that the change of the status string is not considered as a change in the functor status.

virtual void lti::ioHandler::appendStatusString ( const char *  msg  )  const [virtual]

append a message to the current status string.

Take care to reset the status string by calling setStatusString() for each call of an apply() or similar method. appendStatusString() should only be used after setStatusString() has been called.

Parameters:
msg message to be appended to the current status string.

Note that the change of the status string is not considered as a change in the functor status.

Referenced by lti::read().

virtual ioHandler* lti::ioHandler::clone (  )  const [pure virtual]

returns a pointer to a clone of this functor.

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

ioHandler& lti::ioHandler::copy ( const ioHandler other  ) 

copy data of "other" functor.

Parameters:
other the functor to be copied
Returns:
a reference to this functor object

Reimplemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual const int& lti::ioHandler::getLevel (  )  const [virtual]

return the actual nesting level vor begins and ends Example

 ioHandler_childClass h; // h is an ioHandler of a childClass
                         // this could be for example a lispStreamHandler
 int i;
 i = h.getLevel(); // returns 0;
 h.writeBegin();
 i = h.getLevel(); // returns 1;
 h.writeBegin();
 i = h.getLevel(); // returns 2;
 h.writeEnd();
 i = h.getLevel(); // returns 1;
 h.writeEnd();
 i = h.getLevel(); // returns 0;

Referenced by lti::read().

virtual const char* lti::ioHandler::getStatusString (  )  const [virtual]

return the last message set with setStatusString().

This will never return 0. If no status-string has been set yet an empty string (pointer to a string with only the char(0)) will be returned.

virtual const char* lti::ioHandler::getTypeName (  )  const [virtual]

returns the name of this type ("ioHandler")

Reimplemented from lti::object.

Reimplemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( const std::string &  name,
unsigned short &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
short &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
unsigned long &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
long &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
bool &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
ubyte data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
byte data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
char &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
unsigned int &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
int &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
float &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
double &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::read ( const std::string &  name,
std::string &  data 
) [virtual]

read members for symbol-data pairs

virtual bool lti::ioHandler::read ( unsigned short &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( short &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( unsigned long &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( long &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( bool &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( ubyte data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( byte data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( char &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( unsigned int &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( int &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( float &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( double &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::read ( std::string &  data  )  [pure virtual]

read members for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::tree< T >::node::read(), lti::kdTree< T, D, U >::node::read(), and lti::read().

virtual bool lti::ioHandler::readBegin (  )  [virtual]

read the begin token or tokens

Reimplemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::varianceFunctor< T >::parameters::read(), lti::unifiedSymmetricEigenSystem< T >::parameters::read(), lti::unifiedSVD< T >::parameters::read(), lti::unifiedGeneralizedEigenSystem< T >::parameters::read(), lti::tree< T >::node::read(), lti::symmetricMatrixInversion< T >::parameters::read(), lti::singularValueDecomp< T >::parameters::read(), lti::squareConvolution< T, A >::parameters::read(), lti::sort2< T, U >::parameters::read(), lti::sort< T >::parameters::read(), lti::similarityFunctor< T >::parameters::read(), lti::serialVectorStats< T >::parameters::read(), lti::serialStatsFunctor< T, U >::parameters::read(), lti::serialStatsExtFunctor< T, U >::parameters::read(), lti::serialPCA< T >::parameters::read(), lti::scaleSpacePyramid< T >::parameters::read(), lti::scalarValuedInterpolation< T >::parameters::read(), lti::regularizedPCA< T >::parameters::read(), lti::regionGraphFunctor< G >::parameters::read(), lti::quickPartialSort< T >::parameters::read(), lti::qrDecomposition< T >::parameters::read(), lti::principalComponents< T >::parameters::read(), lti::MSTClustering< U >::parameters::read(), lti::MLP::sigmoidFunctor::read(), lti::MLP::activationFunctor::read(), lti::minimumSpanningTree< K, V, Distantor >::parameters::read(), lti::maximumFilter< T >::parameters::read(), lti::matrixInversion< T >::parameters::read(), lti::localMaxima< T >::parameters::read(), lti::linearRegression< T >::parameters::read(), lti::linearAlgebraFunctor::parameters::read(), lti::kdTree< T, D, U >::node::read(), lti::kdTree< T, D, U >::element::read(), lti::genericInterpolator< T >::parameters::read(), lti::generalizedEigenSystem< T >::parameters::read(), lti::gaussianMixtureModel< T >::parameters::read(), lti::gaussian< T >::parameters::read(), lti::forwardSubstitution< T >::parameters::read(), lti::fastSVD< T >::parameters::read(), lti::fastICA< T >::parameters::read(), lti::euclideanSimilarity< T >::parameters::read(), lti::entropyFunctor< T >::parameters::read(), lti::earthMoversDistance< W, C, D >::parameters::read(), lti::draw3D< T >::parameters::read(), lti::draw2DDistribution< T >::parameters::read(), lti::distanceFunctor< T >::parameters::read(), lti::delaunayTriangulation< T >::parameters::read(), lti::DBScan< T >::parameters::read(), lti::cubicSpline< T >::parameters::read(), lti::choleskyDecomposition< T >::parameters::read(), lti::read(), lti::boundingBox< T >::parameters::read(), and lti::backSubstitution< T >::parameters::read().

virtual bool lti::ioHandler::readDataSeparator (  )  [pure virtual]
virtual bool lti::ioHandler::readEnd (  )  [virtual]

read the end token or tokens

Reimplemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::varianceFunctor< T >::parameters::read(), lti::unifiedSymmetricEigenSystem< T >::parameters::read(), lti::unifiedSVD< T >::parameters::read(), lti::unifiedGeneralizedEigenSystem< T >::parameters::read(), lti::tree< T >::node::read(), lti::symmetricMatrixInversion< T >::parameters::read(), lti::singularValueDecomp< T >::parameters::read(), lti::squareConvolution< T, A >::parameters::read(), lti::sort2< T, U >::parameters::read(), lti::sort< T >::parameters::read(), lti::similarityFunctor< T >::parameters::read(), lti::serialVectorStats< T >::parameters::read(), lti::serialStatsFunctor< T, U >::parameters::read(), lti::serialStatsExtFunctor< T, U >::parameters::read(), lti::serialPCA< T >::parameters::read(), lti::scaleSpacePyramid< T >::parameters::read(), lti::scalarValuedInterpolation< T >::parameters::read(), lti::regularizedPCA< T >::parameters::read(), lti::regionGraphFunctor< G >::parameters::read(), lti::quickPartialSort< T >::parameters::read(), lti::qrDecomposition< T >::parameters::read(), lti::principalComponents< T >::parameters::read(), lti::MSTClustering< U >::parameters::read(), lti::MLP::sigmoidFunctor::read(), lti::MLP::activationFunctor::read(), lti::minimumSpanningTree< K, V, Distantor >::parameters::read(), lti::maximumFilter< T >::parameters::read(), lti::matrixInversion< T >::parameters::read(), lti::localMaxima< T >::parameters::read(), lti::linearRegression< T >::parameters::read(), lti::linearAlgebraFunctor::parameters::read(), lti::kdTree< T, D, U >::node::read(), lti::kdTree< T, D, U >::element::read(), lti::genericInterpolator< T >::parameters::read(), lti::generalizedEigenSystem< T >::parameters::read(), lti::gaussianMixtureModel< T >::parameters::read(), lti::gaussian< T >::parameters::read(), lti::forwardSubstitution< T >::parameters::read(), lti::fastSVD< T >::parameters::read(), lti::fastICA< T >::parameters::read(), lti::euclideanSimilarity< T >::parameters::read(), lti::entropyFunctor< T >::parameters::read(), lti::earthMoversDistance< W, C, D >::parameters::read(), lti::draw3D< T >::parameters::read(), lti::draw2DDistribution< T >::parameters::read(), lti::distanceFunctor< T >::parameters::read(), lti::delaunayTriangulation< T >::parameters::read(), lti::DBScan< T >::parameters::read(), lti::cubicSpline< T >::parameters::read(), lti::choleskyDecomposition< T >::parameters::read(), lti::read(), lti::boundingBox< T >::parameters::read(), and lti::backSubstitution< T >::parameters::read().

virtual bool lti::ioHandler::readKeyValueSeparator (  )  [pure virtual]

read key/value separator token.

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::kdTree< T, D, U >::node::read(), and lti::read().

virtual bool lti::ioHandler::readSymbol ( std::string &  data  )  [pure virtual]

read a std::string as a symbol token

A symbol must not contain special characters or spaces. Only letters and numbers are allowed, and the first character must be a letter.

Parameters:
data the symbol readed will be left here

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::read().

virtual void lti::ioHandler::resetLevel ( const int &  theLevel = 0  )  [virtual]

usually this member is needed by reinitialization routines to set the begin/end nesting level to zero.

virtual bool lti::ioHandler::restoreLevel (  )  [pure virtual]

restore all the information in the handler taken in the actual level.

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::read().

virtual void lti::ioHandler::setStatusString ( const std::string &  msg  )  const [virtual]

set a status string.

Parameters:
msg the const string to be reported next time by getStatusString(). The given string will be copied. This message will be usually set within the apply methods to indicate an error cause.

Note that the change of the status string is not considered as a change in the functor status.

virtual void lti::ioHandler::setStatusString ( const char *  msg  )  const [virtual]

set a status string.

Parameters:
msg the const string to be reported next time by getStatusString(). The given string will be copied. This message will be usually set within the apply methods to indicate an error cause.

Note that the change of the status string is not considered as a change in the functor status.

Referenced by lti::genericInterpolator< T >::parameters::read().

virtual bool lti::ioHandler::tryBegin (  )  [pure virtual]

try to read the begin token from the handler.

If present, returns true and the token is removed from the handler, if not present returns false and leaves the handle as it was before calling this member...

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::tryEnd (  )  [pure virtual]

try to read the end token from the handler.

If present, returns true and the token is removed from the handler, if not present returns false and leaves the handle as it was before calling this member...

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::tree< T >::node::read(), lti::read(), and lti::kdTree< T, D, U >::node::read().

virtual bool lti::ioHandler::trySymbol ( const std::string &  data  )  [pure virtual]

try to read the given symbol from the handler.

If present, returns true and the token is removed from the handler, if not present returns false and leaves the handle as it was before calling this member...

A symbol must not contain special characters or spaces. Only letters and numbers are allowed, and the first character must be a letter.

Parameters:
data the symbol to be readed

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::kdTree< T, D, U >::node::read(), and lti::read().

virtual void lti::ioHandler::use ( std::istream &  aStream  )  [pure virtual]

indicate the input stream to be used

Calling this method you will reinitialize the state of the parser (see also clear()).

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual void lti::ioHandler::use ( std::ostream &  aStream  )  [pure virtual]

indicate the output stream to be used

Calling this method you will reinitialize the state of the parser (see also clear()).

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const std::string &  name,
const unsigned short &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const short &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const unsigned long &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const long &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const bool &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const ubyte data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const byte data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const char &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const unsigned int &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const int &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const float &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const double &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const char *  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const std::string &  name,
const std::string &  data 
) [virtual]

write member for symbol-data pairs

virtual bool lti::ioHandler::write ( const unsigned short &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const short &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const unsigned long &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const long &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const bool &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const ubyte data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const byte data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const char &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const unsigned int &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const int &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const float &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const double &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const char *  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::write ( const std::string &  data  )  [pure virtual]

write member for the standard types

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::tree< T >::node::write(), lti::kdTree< T, D, U >::node::write(), and lti::write().

virtual bool lti::ioHandler::writeBegin (  )  [virtual]

write the begin token or tokens

Reimplemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::varianceFunctor< T >::parameters::write(), lti::unifiedSymmetricEigenSystem< T >::parameters::write(), lti::unifiedSVD< T >::parameters::write(), lti::unifiedGeneralizedEigenSystem< T >::parameters::write(), lti::tree< T >::node::write(), lti::symmetricMatrixInversion< T >::parameters::write(), lti::singularValueDecomp< T >::parameters::write(), lti::squareConvolution< T, A >::parameters::write(), lti::sort2< T, U >::parameters::write(), lti::sort< T >::parameters::write(), lti::serialVectorStats< T >::parameters::write(), lti::serialStatsFunctor< T, U >::parameters::write(), lti::serialStatsExtFunctor< T, U >::parameters::write(), lti::serialPCA< T >::parameters::write(), lti::scaleSpacePyramid< T >::parameters::write(), lti::regularizedPCA< T >::parameters::write(), lti::regionGraphFunctor< G >::parameters::write(), lti::quickPartialSort< T >::parameters::write(), lti::qrDecomposition< T >::parameters::write(), lti::principalComponents< T >::parameters::write(), lti::MSTClustering< U >::parameters::write(), lti::MLP::sigmoidFunctor::write(), lti::MLP::activationFunctor::write(), lti::minimumSpanningTree< K, V, Distantor >::parameters::write(), lti::maximumFilter< T >::parameters::write(), lti::matrixInversion< T >::parameters::write(), lti::localMaxima< T >::parameters::write(), lti::linearRegression< T >::parameters::write(), lti::kdTree< T, D, U >::node::write(), lti::kdTree< T, D, U >::element::write(), lti::genericInterpolator< T >::parameters::write(), lti::generalizedEigenSystem< T >::parameters::write(), lti::gaussianMixtureModel< T >::parameters::write(), lti::forwardSubstitution< T >::parameters::write(), lti::fastSVD< T >::parameters::write(), lti::fastICA< T >::parameters::write(), lti::entropyFunctor< T >::parameters::write(), lti::earthMoversDistance< W, C, D >::parameters::write(), lti::draw3D< T >::parameters::write(), lti::draw2DDistribution< T >::parameters::write(), lti::delaunayTriangulation< T >::parameters::write(), lti::DBScan< T >::parameters::write(), lti::cubicSpline< T >::parameters::write(), lti::choleskyDecomposition< T >::parameters::write(), lti::write(), lti::boundingBox< T >::parameters::write(), and lti::backSubstitution< T >::parameters::write().

virtual bool lti::ioHandler::writeComment ( const char *  data  )  [pure virtual]

write comment writes the input data without any preprocessing, just ensuring that the comment format is given

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::writeComment ( const std::string &  data  )  [pure virtual]

write comment writes the input data without any preprocessing, just ensuring that the comment format is given

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::writeDataSeparator (  )  [pure virtual]

write inter-data separator.

The data-separator token separates data elements in a data list or array

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::tree< T >::node::write(), lti::kdTree< T, D, U >::node::write(), lti::kdTree< T, D, U >::element::write(), and lti::write().

virtual bool lti::ioHandler::writeEnd (  )  [virtual]

write the end token or tokens

Reimplemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::varianceFunctor< T >::parameters::write(), lti::unifiedSymmetricEigenSystem< T >::parameters::write(), lti::unifiedSVD< T >::parameters::write(), lti::unifiedGeneralizedEigenSystem< T >::parameters::write(), lti::tree< T >::node::write(), lti::symmetricMatrixInversion< T >::parameters::write(), lti::singularValueDecomp< T >::parameters::write(), lti::squareConvolution< T, A >::parameters::write(), lti::sort2< T, U >::parameters::write(), lti::sort< T >::parameters::write(), lti::serialVectorStats< T >::parameters::write(), lti::serialStatsFunctor< T, U >::parameters::write(), lti::serialStatsExtFunctor< T, U >::parameters::write(), lti::serialPCA< T >::parameters::write(), lti::scaleSpacePyramid< T >::parameters::write(), lti::regularizedPCA< T >::parameters::write(), lti::regionGraphFunctor< G >::parameters::write(), lti::quickPartialSort< T >::parameters::write(), lti::qrDecomposition< T >::parameters::write(), lti::principalComponents< T >::parameters::write(), lti::MSTClustering< U >::parameters::write(), lti::MLP::sigmoidFunctor::write(), lti::MLP::activationFunctor::write(), lti::minimumSpanningTree< K, V, Distantor >::parameters::write(), lti::maximumFilter< T >::parameters::write(), lti::matrixInversion< T >::parameters::write(), lti::localMaxima< T >::parameters::write(), lti::linearRegression< T >::parameters::write(), lti::kdTree< T, D, U >::node::write(), lti::kdTree< T, D, U >::element::write(), lti::genericInterpolator< T >::parameters::write(), lti::generalizedEigenSystem< T >::parameters::write(), lti::gaussianMixtureModel< T >::parameters::write(), lti::forwardSubstitution< T >::parameters::write(), lti::fastSVD< T >::parameters::write(), lti::fastICA< T >::parameters::write(), lti::entropyFunctor< T >::parameters::write(), lti::earthMoversDistance< W, C, D >::parameters::write(), lti::draw3D< T >::parameters::write(), lti::draw2DDistribution< T >::parameters::write(), lti::delaunayTriangulation< T >::parameters::write(), lti::DBScan< T >::parameters::write(), lti::cubicSpline< T >::parameters::write(), lti::choleskyDecomposition< T >::parameters::write(), lti::write(), lti::boundingBox< T >::parameters::write(), and lti::backSubstitution< T >::parameters::write().

virtual bool lti::ioHandler::writeEOL (  )  [pure virtual]

write end-of-line token The EOL are tokes that will be ignored by reading

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::tree< T >::node::write(), lti::kdTree< T, D, U >::node::write(), and lti::write().

virtual bool lti::ioHandler::writeKeyValueSeparator (  )  [pure virtual]

write key/value separator.

The key/value separator is the token which will separate a symbol from its value in a symbol-data-pair.

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::kdTree< T, D, U >::node::write(), and lti::write().

virtual bool lti::ioHandler::writeSpaces ( const int &  s = 1  )  [pure virtual]

write spaces (default value 1) The spaces are tokes that will be ignored by reading

Parameters:
s the number of space-tokens to be written

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

virtual bool lti::ioHandler::writeSymbol ( const std::string &  data  )  [pure virtual]

write a std::string as a symbol token.

A symbol must not contain special characters or spaces. Only letters and numbers are allowed, and the first character must be a letter.

Parameters:
data The symbol to be written

Implemented in lti::binaryStreamHandler, and lti::lispStreamHandler.

Referenced by lti::kdTree< T, D, U >::node::write(), and lti::write().


Member Data Documentation

int lti::ioHandler::level [protected]

begin() nesting level


The documentation for this class was generated from the following file:

Generated on Sat Apr 10 15:28:08 2010 for LTI-Lib by Doxygen 1.6.1