Object Class Reference

Abstract ancestor of all persistent objects. More...

#include <cObject.h>

Inheritance diagram for Object:

[legend]Collaboration diagram for Object:

[legend]List of all members.

Public Member Functions
	Object ()
	~Object ()
	ABSTRACT_CLASS (Object)
	PARENTS (NULL)
	FROM ("")
	WHERE ("")
	GROUP_BY ("")
	HAVING ("")
	ORDER_BY ("")
virtual class Object *	IsInMemory () const
virtual class ObjectIdentification	ObjectID () const
virtual bool	PostLoad ()
virtual bool	Refresh ()
virtual bool	Update ()
virtual bool	Free ()
virtual bool	Delete ()
virtual class Object *	MemoryLock ()
virtual bool	MemoryUnlock ()
virtual unsigned int	MemoryLocked () const
virtual bool	IsTransient () const
virtual bool	IsPersistent () const
virtual class RefBase	BePersistent (class Connection *DbCon)
virtual class RefBase	Address () const
Static Public Member Functions
const char *	RootClassName ()
const char *	BaseClassName ()
Public Attributes
MAPKEY_BEGIN	MAPKEY_END
MAP_BEGIN	MAP_END
Protected Member Functions
virtual bool	_Free ()
virtual bool	IsDirty () const
virtual bool	MarkAsDirty ()
virtual bool	_MarkAsClean ()
virtual char *	_KeyValues () const
virtual bool	_Refresh ()
virtual class RefBase	_Virtualise (RefBase &DbPtr) const
virtual const char *	_SelectKeyValues (const RefBase &DbPtr) const
virtual bool	_VersionsMatch ()
Protected Attributes
bool	_FreeWasDone
bool	_ForUpdate

---

Detailed Description

Abstract ancestor of all persistent objects.

This class is parent of IopcPersistentObject, ancestor of all IOPC-style persistent objects, as well as parent of ImmutableObject, DatabaseObject and PersistentObject, that are ancestors of POLiTe-style persistent objects.

Because this class comes from POLiTe, it contains some preprocessor macros (f.e. ABSTRACT_CLASS, FROM and so on) that generates some methods not needed and not used in IOPC.

This class was partially documented in POLiTe, these old comments can be found in class's header, not in doxygen. I (Josef Troch) have added only this introductory comment. To find out, what should methods of this class do, it may be usefull to view documentation of IopcPersistentObject.

---

Constructor & Destructor Documentation

Object::Object (   )

Object::~Object (   )

---

Member Function Documentation

bool Object::_Free (   )  [protected, virtual]

Implements ObjRef.

const char* Object::RootClassName (   )  [inline, static]

Reimplemented in ImmutableObject, and PersistentObject.

const char* Object::BaseClassName (   )  [inline, static]

Reimplemented in DatabaseObject, ImmutableObject, and PersistentObject.

Object::ABSTRACT_CLASS (  Object   )

Object::PARENTS (  NULL   )

Reimplemented in ImmutableObject.

Object::FROM (  ""   )

Reimplemented in ImmutableObject.

Object::WHERE (  ""   )

Reimplemented in ImmutableObject.

Object::GROUP_BY (  ""   )

Reimplemented in ImmutableObject.

Object::HAVING (  ""   )

Reimplemented in ImmutableObject.

Object::ORDER_BY (  ""   )

Reimplemented in ImmutableObject.

virtual class Object* Object::IsInMemory (   )  const [inline, virtual]

Implements ObjRef.

ObjectIdentification Object::ObjectID (   )  const [virtual]

Implements ObjRef.

virtual bool Object::PostLoad (   )  [inline, virtual]

virtual bool Object::IsDirty (   )  const [inline, protected, virtual]

Implements ObjRef. Reimplemented in DatabaseObject, and IopcPersistentObject.

virtual bool Object::MarkAsDirty (   )  [inline, protected, virtual]

Implements ObjRef. Reimplemented in DatabaseObject, and IopcPersistentObject.

virtual bool Object::_MarkAsClean (   )  [inline, protected, virtual]

Implements ObjRef. Reimplemented in DatabaseObject, and IopcPersistentObject.

char * Object::_KeyValues (   )  const [protected, virtual]

Implements ObjRef.

bool Object::_Refresh (   )  [protected, virtual]

bool Object::Refresh (   )  [virtual]

Implements ObjRef.

bool Object::Update (   )  [virtual]

Implements ObjRef. Reimplemented in PersistentObject, and IopcPersistentObject.

bool Object::Free (   )  [virtual]

Implements ObjRef. Reimplemented in IopcPersistentObject.

bool Object::Delete (   )  [virtual]

Implements ObjRef. Reimplemented in IopcPersistentObject.

virtual class Object* Object::MemoryLock (   )  [inline, virtual]

Implements ObjRef. Reimplemented in ImmutableObject.

virtual bool Object::MemoryUnlock (   )  [inline, virtual]

Implements ObjRef. Reimplemented in ImmutableObject.

virtual unsigned int Object::MemoryLocked (   )  const [inline, virtual]

Implements ObjRef. Reimplemented in ImmutableObject.

virtual bool Object::IsTransient (   )  const [inline, virtual]

Reimplemented from ObjRef. Reimplemented in ImmutableObject, and IopcPersistentObject.

virtual bool Object::IsPersistent (   )  const [inline, virtual]

Reimplemented from ObjRef. Reimplemented in ImmutableObject, and IopcPersistentObject.

virtual class RefBase Object::BePersistent (  class Connection *  DbCon  )  [inline, virtual]

Implements ObjRef. Reimplemented in DatabaseObject, PersistentObject, and IopcPersistentObject.

RefBase Object::Address (   )  const [virtual]

virtual class RefBase Object::_Virtualise (  RefBase &  DbPtr  )  const [inline, protected, virtual]

virtual const char* Object::_SelectKeyValues (  const RefBase &  DbPtr  )  const [inline, protected, virtual]

virtual bool Object::_VersionsMatch (   )  [inline, protected, virtual]

Reimplemented in PersistentObject.

---

Member Data Documentation

bool Object::_FreeWasDone [protected]

bool Object::_ForUpdate [protected]

MAPKEY_BEGIN Object::MAPKEY_END

Reimplemented in ImmutableObject.

MAP_BEGIN Object::MAP_END

Reimplemented in ImmutableObject.

---

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

• cObject.h
• cObject.cpp

---

Generated on Wed Aug 11 22:35:55 2004 for IOPC by Doxygen 1.3.6