Project homepage
Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

O3DBIObject Class Reference

#include <O3DBIObject.h>

Inheritance diagram for O3DBIObject:

Inheritance graph
[legend]
Collaboration diagram for O3DBIObject:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 O3DBIObject ()
virtual ~O3DBIObject ()
virtual TO3DBIString ToString (void) const
virtual bool IsValid (void) const

Static Public Member Functions

void RegisterMemAllocCB (MemAllocFP memallocfp)
void RegisterReAllocCB (ReAllocFP reallocfp)
void RegisterMemFreeCB (MemFreeFP memfreefp)

Detailed Description

This is the base class of the whole O3DBI class hierarchy, except O3DBIException.

Definition at line 58 of file O3DBIObject.h.

Constructor & Destructor Documentation

O3DBIObject::O3DBIObject (   ) 
 

The default constructor.

Exceptions:
O3DBIException - if the creation of an OCI environment fails or if the allocation of several handles is not successful.

Definition at line 47 of file O3DBIObject.cpp.

References ENSURE, TOCIDvoidPtr, and TOCIResult.

O3DBIObject::~O3DBIObject (   )  [virtual]
 

The virtual destructor.

Definition at line 88 of file O3DBIObject.cpp.

Member Function Documentation

bool O3DBIObject::IsValid (  void   )  const [virtual]
 

This virtual function will be invoked if the IS_VALID macro is applied on an instance of this class. This function has to check to ensure that the object is in a consistent state. A programmer should invoke this method before acting on an object pointer. See DbC.h for detailed informations about the Design By Contact methodology.

Example of usage
        O3DBIObject* pObject = new O3DBIObject();
        IS_VALID(pObject);  // Invokes IsValid()

Implements DbC.

Definition at line 118 of file O3DBIObject.cpp.

void O3DBIObject::RegisterMemAllocCB (  MemAllocFP  memallocfp  )  [static]
 

This class function can be used to specify a memory allocation function.

Attention:
The memory allocation routine must be thread safe!
Parameters:
memallocfp is a function pointer to a user-defined memory allocation function.

Definition at line 29 of file O3DBIObject.cpp.

void O3DBIObject::RegisterMemFreeCB (  MemFreeFP  memfreefp  )  [static]
 

This class function can be used to specify a memory free function.

Attention:
The memory free routine must be thread safe!
Parameters:
memfreefp is a function pointer to a user-defined memory free function.

Definition at line 39 of file O3DBIObject.cpp.

void O3DBIObject::RegisterReAllocCB (  ReAllocFP  reallocfp  )  [static]
 

This class function can be used to specify a memory re-allocation function.

Attention:
The memory re-allocation routine must be thread safe!
Parameters:
reallocfp is a function pointer to a user-defined memory re-allocation function.

Definition at line 34 of file O3DBIObject.cpp.

TO3DBIString O3DBIObject::ToString (  void   )  const [virtual]
 

This member function returns a string that "textually represents" this object.

Returns:
A TO3DBIString object containing the string.

Reimplemented in O3DBIBfile, O3DBIBlob, O3DBIClob, O3DBIDatabase, O3DBIDataField, O3DBIDate, O3DBIRecord, O3DBIRecordSet, O3DBIStatement, O3DBITimestamp, and O3DBIXml.

Definition at line 104 of file O3DBIObject.cpp.

References TO3DBIString.

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

SourceForge.net Logo Generated on Sun Jan 23 11:36:47 2005 for Oracle Object Oriented Database Interface (O3DBI) by  doxygen 1.3.9.1