ost_baseobject(3) [debian man page]

ost::BaseObject(3)					     Library Functions Manual						ost::BaseObject(3)

NAME

       ost::BaseObject -

       BaseObject.

SYNOPSIS

       #include <persist.h>

   Public Member Functions
       BaseObject ()
	   This constructor is used in serialisation processes.
       virtual ~BaseObject ()
	   Default destructor.
       virtual const char * getPersistenceID () const
	   This returns the ID of the persistent object (Its type)
       virtual bool write (Engine &archive) const
	   This method is used to write to the Persistence::Engine It is not equivalent to the << operator as it writes only the data and not the
	   object type etc.
       virtual bool read (Engine &archive)
	   This method is used to read from a Persistence::Engine It is not equivalent to the >> operator as it does no typesafety or anything.

Detailed Description
       BaseObject.

       This object is the base for all Persistent data which is not natively serialised by the Persistence::Engine

       It registers itself with the Persistence::TypeManager using a global constructor function. A matching deregister call is made in a global
       destructor, to allow DLL's to use the Persistence::Engine in a main executable.

       Persistable objects must never maintain bad pointers. If a pointer doesn't point to something valid, it must be NULL. This is so the
       persistence engine knows whether to allocate memory for an object or whether the memory has been pre-allocated.

       Author:
	   Daniel Silverstone Base class for classes that will be persistent.

Constructor &; Destructor Documentation
   ost::BaseObject::BaseObject ()
       This constructor is used in serialisation processes. It is called in CreateNewInstance in order to create an instance of the class to have
       Read() called on it.

   virtual ost::BaseObject::~BaseObject () [virtual]
       Default destructor.

Member Function Documentation
   virtual const char* ost::BaseObject::getPersistenceID () const [virtual]
       This returns the ID of the persistent object (Its type)

   virtual bool ost::BaseObject::read (Engine &archive) [virtual]
       This method is used to read from a Persistence::Engine It is not equivalent to the >> operator as it does no typesafety or anything.

   virtual bool ost::BaseObject::write (Engine &archive) const [virtual]
       This method is used to write to the Persistence::Engine It is not equivalent to the << operator as it writes only the data and not the
       object type etc.

Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012						ost::BaseObject(3)

ost::CommandOptionParse(3)				     Library Functions Manual					ost::CommandOptionParse(3)

NAME

       ost::CommandOptionParse -

       This is the CommandOptionParse interface class.

SYNOPSIS

       #include <cmdoptns.h>

   Public Member Functions
       virtual ~CommandOptionParse ()=0
	   Virtual destructor needed so that the object may be correctly deleted.
       virtual bool argsHaveError ()=0
	   Get the value of the error flag set if the parser encountered errors.
       virtual const char * printErrors ()=0
	   Return a string of text describing the list of errors encountered.
       virtual const char * printUsage ()=0
	   Return a string that contains the usage description of this list of paramaters.
       virtual void registerError (const char *errMsg)=0
	   Register an error with this parser.
       virtual void performTask ()=0
	   The method should be invoked by the main code once it has determined that the application should be started.

Detailed Description
       This is the CommandOptionParse interface class.

       To implement this object you can call makeCommandOptionParse(); This will instantiate a dynamically allocated version of this class and
       parse the command line for the list of command options that are passed in.

       Author:
	   Gianni Mariani gianni@mariani.ws

       Examples:
	   cmdlineopt.cpp.

Constructor &; Destructor Documentation
   virtual ost::CommandOptionParse::~CommandOptionParse () [pure virtual]
       Virtual destructor needed so that the object may be correctly deleted.

Member Function Documentation
   virtual bool ost::CommandOptionParse::argsHaveError () [pure virtual]
       Get the value of the error flag set if the parser encountered errors.

       Examples:
	   cmdlineopt.cpp.

   virtual void ost::CommandOptionParse::performTask () [pure virtual]
       The method should be invoked by the main code once it has determined that the application should be started.

       Examples:
	   cmdlineopt.cpp.

   virtual const char* ost::CommandOptionParse::printErrors () [pure virtual]
       Return a string of text describing the list of errors encountered.

       Examples:
	   cmdlineopt.cpp.

   virtual const char* ost::CommandOptionParse::printUsage () [pure virtual]
       Return a string that contains the usage description of this list of paramaters.

       Examples:
	   cmdlineopt.cpp.

   virtual void ost::CommandOptionParse::registerError (const char *errMsg) [pure virtual]
       Register an error with this parser. This string will be appended to the errors already buffered in this object.

       Examples:
	   cmdlineopt.cpp.

Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012					ost::CommandOptionParse(3)