Public Member Functions | Data Fields

KogniMobil::RTDBObj Class Reference
[C++ Classes for Data Objects.]

Base-Classes for a Real-time Database Object. More...

#include <kogmo_rtdb_obj_base_classes.hxx>

Inheritance diagram for KogniMobil::RTDBObj:
KogniMobil::C3_Process KogniMobil::C3_RTDB KogniMobil::RTDBObj_T< kogmo_rtdb_subobj_a2_image_t, KOGMO_RTDB_OBJTYPE_A2_IMAGE, RTDBObj, width *height *channels *bits/8 > KogniMobil::A2_Image< width, height, channels, bits > KogniMobil::A2_AnyImage

Public Member Functions

 RTDBObj (const class RTDBConn &DBC, const char *name="", const int &otype=0, const int32_t &child_size=0, char **child_dataptr=NULL)
 RTDBObj (const RTDBObj &src)
 Copy Constructor. Makes a shallow copy. Pointers and database-handles are shared with original object.
virtual ~RTDBObj ()
bool Copy (const RTDBObj &src, int force=0)
kogmo_rtdb_handle_t * getDBC () const
kogmo_rtdb_obj_info_t * getObjInfo () const
kogmo_rtdb_subobj_base_t * getObjData () const
void RTDBInsert (void)
void RTDBDelete (void)
void setTimes (float avg_cycletime, float max_cycletime, float history_interval)
float getAvgCycleTime () const
float getMaxCycleTime () const
float getHistoryInterval () const
kogmo_rtdb_objid_t getOID () const
void newObject ()
std::string getName () const
void setName (std::string name)
kogmo_rtdb_objtype_t getType () const
void setType (kogmo_rtdb_objtype_t type)
kogmo_rtdb_objid_t getParent () const
void setParent (kogmo_rtdb_objid_t oid)
void setAllowPublicRead (bool yes=true)
void setAllowPublicWrite (bool yes=true)
void setForceUnique (bool yes=true)
void setCycleWatch (bool yes=true)
void setPersistent (bool yes=true)
void setParentDelete (bool yes=true)
Timestamp getCreatedTimestamp () const
Timestamp getDeletedTimestamp () const
bool isDeleted () const
kogmo_rtdb_objid_t getDeletededProcOID () const
kogmo_rtdb_objid_t getCreatedProcOID () const
std::string getDeletededProcInfo () const
std::string getCreatedProcInfo () const
kogmo_rtdb_objsize_t getMaxSize () const
kogmo_rtdb_objsize_t getMinSize () const
void setMinSize (kogmo_rtdb_objsize_t size=0)
void RTDBWrite (int32_t size=0, Timestamp ts=0)
void RTDBRead (Timestamp ts=0)
void RTDBReadDataTime (Timestamp ts=0)
void RTDBReadWaitNext (Timestamp old_ts=0, float timeout=0)
void RTDBReadDataYounger (Timestamp old_ts=0)
void RTDBReadYounger (Timestamp old_ts=0)
void RTDBReadDataOlder (Timestamp old_ts=0)
void RTDBReadOlder (Timestamp old_ts=0)
void RTDBReadWaitSuccessor (Timestamp old_ts=0)
void RTDBReadPredecessor (Timestamp old_ts=0)
bool isValid (Timestamp ts=0)
Timestamp getTimestamp () const
void setTimestamp (Timestamp ts=0)
Timestamp getDataTimestamp () const
void setDataTimestamp (Timestamp ts=0)
Timestamp getCommittedTimestamp () const
kogmo_rtdb_objid_t getCommittedProcOID () const
std::string getCommittedProcInfo () const
kogmo_rtdb_objsize_t getSize () const
void setSize (int size=0)
void RTDBSearch (kogmo_rtdb_objid_t oid, Timestamp ts=0)
void RTDBSearch (const char *name="", kogmo_rtdb_objid_t parent_oid=0, kogmo_rtdb_objid_t proc_oid=0, Timestamp ts=0, int nth=1, kogmo_rtdb_objtype_t type=-1)
void RTDBSearchWait (const char *name="", kogmo_rtdb_objid_t parent_oid=0, kogmo_rtdb_objid_t proc_oid=0, float timeout=0)
virtual std::string dump (void) const

Data Fields

kogmo_rtdb_handle_t * db_h
kogmo_rtdb_obj_info_t * objinfo_p
kogmo_rtdb_subobj_base_t * objbase_p
kogmo_rtdb_objsize_t * objsize_p
kogmo_rtdb_objsize_t * objsize_min_p

Detailed Description

Base-Classes for a Real-time Database Object.

Definition at line 42 of file kogmo_rtdb_obj_base_classes.hxx.

Constructor & Destructor Documentation

KogniMobil::RTDBObj::RTDBObj ( const class RTDBConn &  DBC,
const char *  name = "",
const int &  otype = 0,
const int32_t &  child_size = 0,
char **  child_dataptr = NULL 
) [inline]

Definition at line 57 of file kogmo_rtdb_obj_base_classes.hxx.

KogniMobil::RTDBObj::RTDBObj ( const RTDBObj &  src  )  [inline]

Copy Constructor. Makes a shallow copy. Pointers and database-handles are shared with original object.

Definition at line 95 of file kogmo_rtdb_obj_base_classes.hxx.

virtual KogniMobil::RTDBObj::~RTDBObj (  )  [inline, virtual]

Definition at line 107 of file kogmo_rtdb_obj_base_classes.hxx.

Member Function Documentation

bool KogniMobil::RTDBObj::Copy ( const RTDBObj &  src,
int  force = 0 
) [inline]

Definition at line 124 of file kogmo_rtdb_obj_base_classes.hxx.

virtual std::string KogniMobil::RTDBObj::dump ( void   )  const [inline, virtual]

Reimplemented in KogniMobil::C3_RTDB, KogniMobil::C3_Process, and KogniMobil::A2_Image< width, height, channels, bits >.

Definition at line 704 of file kogmo_rtdb_obj_base_classes.hxx.

float KogniMobil::RTDBObj::getAvgCycleTime (  )  const [inline]

Definition at line 209 of file kogmo_rtdb_obj_base_classes.hxx.

std::string KogniMobil::RTDBObj::getCommittedProcInfo (  )  const [inline]

Definition at line 618 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objid_t KogniMobil::RTDBObj::getCommittedProcOID (  )  const [inline]

Definition at line 613 of file kogmo_rtdb_obj_base_classes.hxx.

Timestamp KogniMobil::RTDBObj::getCommittedTimestamp (  )  const [inline]

Definition at line 608 of file kogmo_rtdb_obj_base_classes.hxx.

std::string KogniMobil::RTDBObj::getCreatedProcInfo (  )  const [inline]

Definition at line 348 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objid_t KogniMobil::RTDBObj::getCreatedProcOID (  )  const [inline]

Definition at line 333 of file kogmo_rtdb_obj_base_classes.hxx.

Timestamp KogniMobil::RTDBObj::getCreatedTimestamp (  )  const [inline]

Definition at line 313 of file kogmo_rtdb_obj_base_classes.hxx.

Timestamp KogniMobil::RTDBObj::getDataTimestamp (  )  const [inline]

Definition at line 596 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_handle_t* KogniMobil::RTDBObj::getDBC (  )  const [inline]

Definition at line 149 of file kogmo_rtdb_obj_base_classes.hxx.

std::string KogniMobil::RTDBObj::getDeletededProcInfo (  )  const [inline]

Definition at line 338 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objid_t KogniMobil::RTDBObj::getDeletededProcOID (  )  const [inline]

Definition at line 328 of file kogmo_rtdb_obj_base_classes.hxx.

Timestamp KogniMobil::RTDBObj::getDeletedTimestamp (  )  const [inline]

Definition at line 318 of file kogmo_rtdb_obj_base_classes.hxx.

float KogniMobil::RTDBObj::getHistoryInterval (  )  const [inline]

Definition at line 219 of file kogmo_rtdb_obj_base_classes.hxx.

float KogniMobil::RTDBObj::getMaxCycleTime (  )  const [inline]

Definition at line 214 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objsize_t KogniMobil::RTDBObj::getMaxSize (  )  const [inline]

Definition at line 358 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objsize_t KogniMobil::RTDBObj::getMinSize (  )  const [inline]

Definition at line 366 of file kogmo_rtdb_obj_base_classes.hxx.

std::string KogniMobil::RTDBObj::getName (  )  const [inline]

Definition at line 234 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_subobj_base_t* KogniMobil::RTDBObj::getObjData (  )  const [inline]

Definition at line 165 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_obj_info_t* KogniMobil::RTDBObj::getObjInfo (  )  const [inline]

Definition at line 160 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objid_t KogniMobil::RTDBObj::getOID (  )  const [inline]

Definition at line 224 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objid_t KogniMobil::RTDBObj::getParent (  )  const [inline]

Definition at line 259 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objsize_t KogniMobil::RTDBObj::getSize (  )  const [inline]

Definition at line 628 of file kogmo_rtdb_obj_base_classes.hxx.

Timestamp KogniMobil::RTDBObj::getTimestamp (  )  const [inline]

Definition at line 586 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objtype_t KogniMobil::RTDBObj::getType (  )  const [inline]

Definition at line 247 of file kogmo_rtdb_obj_base_classes.hxx.

bool KogniMobil::RTDBObj::isDeleted (  )  const [inline]

Definition at line 323 of file kogmo_rtdb_obj_base_classes.hxx.

bool KogniMobil::RTDBObj::isValid ( Timestamp  ts = 0  )  [inline]

Definition at line 572 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::newObject (  )  [inline]

Definition at line 229 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBDelete ( void   )  [inline]

Definition at line 187 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBInsert ( void   )  [inline]

Definition at line 177 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBRead ( Timestamp  ts = 0  )  [inline]

Definition at line 412 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadDataOlder ( Timestamp  old_ts = 0  )  [inline]

Definition at line 496 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadDataTime ( Timestamp  ts = 0  )  [inline]

Definition at line 426 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadDataYounger ( Timestamp  old_ts = 0  )  [inline]

Definition at line 464 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadOlder ( Timestamp  old_ts = 0  )  [inline]

Definition at line 512 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadPredecessor ( Timestamp  old_ts = 0  )  [inline]

Definition at line 553 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadWaitNext ( Timestamp  old_ts = 0,
float  timeout = 0 
) [inline]

Definition at line 440 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadWaitSuccessor ( Timestamp  old_ts = 0  )  [inline]

Definition at line 533 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBReadYounger ( Timestamp  old_ts = 0  )  [inline]

Definition at line 480 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBSearch ( kogmo_rtdb_objid_t  oid,
Timestamp  ts = 0 
) [inline]

Definition at line 654 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBSearch ( const char *  name = "",
kogmo_rtdb_objid_t  parent_oid = 0,
kogmo_rtdb_objid_t  proc_oid = 0,
Timestamp  ts = 0,
int  nth = 1,
kogmo_rtdb_objtype_t  type = -1 
) [inline]

Definition at line 673 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBSearchWait ( const char *  name = "",
kogmo_rtdb_objid_t  parent_oid = 0,
kogmo_rtdb_objid_t  proc_oid = 0,
float  timeout = 0 
) [inline]

Definition at line 686 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::RTDBWrite ( int32_t  size = 0,
Timestamp  ts = 0 
) [inline]

Reimplemented in KogniMobil::C3_Process.

Definition at line 392 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setAllowPublicRead ( bool  yes = true  )  [inline]

Definition at line 271 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setAllowPublicWrite ( bool  yes = true  )  [inline]

Definition at line 278 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setCycleWatch ( bool  yes = true  )  [inline]

Definition at line 292 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setDataTimestamp ( Timestamp  ts = 0  )  [inline]

Definition at line 601 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setForceUnique ( bool  yes = true  )  [inline]

Definition at line 285 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setMinSize ( kogmo_rtdb_objsize_t  size = 0  )  [inline]

Definition at line 371 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setName ( std::string  name  )  [inline]

Definition at line 239 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setParent ( kogmo_rtdb_objid_t  oid  )  [inline]

Definition at line 264 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setParentDelete ( bool  yes = true  )  [inline]

Definition at line 306 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setPersistent ( bool  yes = true  )  [inline]

Definition at line 299 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setSize ( int  size = 0  )  [inline]

Definition at line 633 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setTimes ( float  avg_cycletime,
float  max_cycletime,
float  history_interval 
) [inline]
Parameters:
avg_cycletime Expected average time between Object-Changes (commits). If unknown set to max_cycletime.
max_cycletime Minimum time between Object-Changes (commits).
history_interval Time Interval in Seconds the History of Object-Data should be kept. History-Size(buffer depth) will be history_size = history_interval / max_cycletime) + 1

Definition at line 196 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setTimestamp ( Timestamp  ts = 0  )  [inline]

Definition at line 591 of file kogmo_rtdb_obj_base_classes.hxx.

void KogniMobil::RTDBObj::setType ( kogmo_rtdb_objtype_t  type  )  [inline]

Definition at line 252 of file kogmo_rtdb_obj_base_classes.hxx.

Field Documentation

kogmo_rtdb_handle_t* KogniMobil::RTDBObj::db_h

Definition at line 46 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_subobj_base_t* KogniMobil::RTDBObj::objbase_p

Definition at line 48 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_obj_info_t* KogniMobil::RTDBObj::objinfo_p

Definition at line 47 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objsize_t* KogniMobil::RTDBObj::objsize_min_p

Definition at line 50 of file kogmo_rtdb_obj_base_classes.hxx.

kogmo_rtdb_objsize_t* KogniMobil::RTDBObj::objsize_p

Definition at line 49 of file kogmo_rtdb_obj_base_classes.hxx.

The documentation for this class was generated from the following file:
Generated for KogMo-RTDB by Matthias.Goebl (mattias.goebl*kogmo-rtdb.de) - all rights reserved.