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)
Check Out this Related Man Page
ost::Time(3) Library Functions Manual ost::Time(3)NAME
ost::Time -
The Time class uses a integer representation of the current time.
SYNOPSIS
#include <numbers.h>
Inherited by ost::Datetime.
Public Member Functions
Time (time_t tm)
Time (tm *dt)
Time (char *str, size_t size=0)
Time (int hour, int minute, int second)
Time ()
virtual ~Time ()
long getValue (void) const
int getHour (void) const
int getMinute (void) const
int getSecond (void) const
char * getTime (char *buffer) const
time_t getTime (void) const
tm * getTime (tm *buf) const
void setTime (char *str, size_t size=0)
bool isValid (void) const
operator long ()
String operator() () const
Time & operator++ ()
Time & operator-- ()
Time & operator+= (const int val)
Time & operator-= (const int val)
int operator== (const Time &time)
int operator!= (const Time &time)
int operator< (const Time &time)
int operator<= (const Time &time)
int operator> (const Time &time)
int operator>= (const Time &time)
bool operator! () const
Protected Member Functions
void toSeconds (int hour, int minute, int second)
void fromSeconds (char *buf) const
virtual void update (void)
Protected Attributes
long seconds
Friends
Time operator+ (const Time &time1, const Time &time2)
Time operator- (const Time &time1, const Time &time2)
Time operator+ (const Time &time, const int val)
Time operator- (const Time &time, const int val)
Time operator+ (const int val, const Time &time)
Time operator- (const int val, const Time &time)
Detailed Description
The Time class uses a integer representation of the current time.
This is then manipulated in several forms and may be exported as needed.
Author:
Marcelo Dalmas mad@brasmap.com.br Integer based time class.
Constructor & Destructor Documentation
ost::Time::Time (time_ttm)
ost::Time::Time (tm *dt)
ost::Time::Time (char *str, size_tsize = 0)
ost::Time::Time (inthour, intminute, intsecond)
ost::Time::Time ()
virtual ost::Time::~Time () [virtual]
Member Function Documentation
void ost::Time::fromSeconds (char *buf) const [protected]
int ost::Time::getHour (void) const
int ost::Time::getMinute (void) const
int ost::Time::getSecond (void) const
char* ost::Time::getTime (char *buffer) const
time_t ost::Time::getTime (void) const
tm* ost::Time::getTime (tm *buf) const
long ost::Time::getValue (void) const
bool ost::Time::isValid (void) const
Reimplemented in ost::Datetime.
ost::Time::operator long () [inline]
bool ost::Time::operator! (void) const [inline]
Reimplemented in ost::Datetime.
int ost::Time::operator!= (const Time &time)
String ost::Time::operator() () const
Time& ost::Time::operator++ ()
Time& ost::Time::operator+= (const intval)
Time& ost::Time::operator-- ()
Time& ost::Time::operator-= (const intval)
int ost::Time::operator< (const Time &time)
int ost::Time::operator<= (const Time &time)
int ost::Time::operator== (const Time &time)
int ost::Time::operator> (const Time &time)
int ost::Time::operator>= (const Time &time)
void ost::Time::setTime (char *str, size_tsize = 0)
void ost::Time::toSeconds (inthour, intminute, intsecond) [protected]
virtual void ost::Time::update (void) [protected], [virtual]
Friends And Related Function Documentation
Time operator+ (const Time &time1, const Time &time2) [friend]
Time operator+ (const Time &time, const intval) [friend]
Time operator+ (const intval, const Time &time) [friend]
Time operator- (const Time &time1, const Time &time2) [friend]
Time operator- (const Time &time, const intval) [friend]
Time operator- (const intval, const Time &time) [friend]
Member Data Documentation
long ost::Time::seconds [protected]
Author
Generated automatically by Doxygen for GNU CommonC++ from the source code.
GNU CommonC++ Sat Jun 23 2012 ost::Time(3)