OCDM_Object Class Reference

The base class of all OCDM objects. More...

#include <OCDM.h>

Inheritance diagram for OCDM_Object:

OCDM_Annotation OCDM_AnnotationSet OCDM_Attribute OCDM_AttributeSet OCDM_AttributeValue OCDM_ByteSequence OCDM_RawData OCDM_Span OCDM_SpanSet List of all members.

Public Member Functions

void ensureValidity (void) const
 OCDM_Object ()
 This is the empty constructor.
 OCDM_Object (const CDM_Object)
 This is a constructor that creates an OCDM object from a CDM object.
 OCDM_Object (const class OCDM_Object &)
 This is the default copy constructor.
 ~OCDM_Object ()
 This is the default destructor.
virtual class OCDM_Objectoperator= (const class OCDM_Object &)
 This is the default assignment operator.
void initObject (const CDM_Object) const
void setObject (const CDM_Object) const
const CDM_Object getObject (void) const
void releaseObject (void) const
void deleteObject (void) const
void storeObject (const class OCDM_Object *objPtr) const
const class OCDM_ObjectgetStoredObject (void) const
void releaseStoredObject (void) const
void Log (const char *str,...) const
 This method logs information. It is equivalent to OCDM_Utilities::Log().
long size (void) const
 This method returns the number of elements contained in the object.
bool empty (void) const
bool isEmpty (void) const
OCDM_BOOL Valid (void) const
 This method returns true if the OCDM object is valid.
const char * toString (void) const
 This method returns a string representation of the object.
virtual const char * objectType (void) const

Detailed Description

Description:
This class is the base class for all OCDM objects, as all OCDM objects inherit this class. It provides all the common functionality offered by all OCDM objects.


Constructor & Destructor Documentation

OCDM_Object  ) 
 

Description:
This is the empty constructor. It creates an object that is empty.

OCDM_Object const   CDM_Object  ) 
 

Description:
This is a constructor that creates an OCDM object from a CDM object.
Arguments:
  • obj: the object to be reflected to the object oriented (OCDM) API.

OCDM_Object const class OCDM_Object obj  ) 
 

Description:
This is the default copy constructor.
Arguments:
  • obj: the object to be copied.

~OCDM_Object  ) 
 

Description: * This is the default destructor.


Member Function Documentation

void deleteObject void   )  const
 

bool empty void   )  const [inline]
 

void ensureValidity void   )  const [inline]
 

const CDM_Object getObject void   )  const
 

const class OCDM_Object * getStoredObject void   )  const
 

void initObject const   CDM_Object  )  const
 

bool isEmpty void   )  const [inline]
 

void Log const char *  str,
  ...
const
 

const char * objectType void   )  const [virtual]
 

This method returns the type of the object as a string.

Reimplemented in OCDM_ByteSequence, OCDM_ByteSequenceSet, OCDM_RawData, OCDM_RawDataSet, OCDM_Span, OCDM_SpanSet, OCDM_AttributeValue, OCDM_Attribute, OCDM_AttributeSet, OCDM_Annotation, and OCDM_AnnotationSet.

class OCDM_Object & operator= const class OCDM_Object obj  )  [virtual]
 

Description: This is the default sssignment operator. Note that under
languages that do not support operator overloading (i.e. Java, Perl, Python) this operator appears as a plain method named as "set".
Arguments:
  • obj: the object to be copied.
Returns:
This method returns a reference to the current object.

Reimplemented in OCDM_ByteSequence, OCDM_ByteSequenceSet, OCDM_RawData, OCDM_RawDataSet, OCDM_Span, OCDM_SpanSet, OCDM_AttributeValue, OCDM_Attribute, OCDM_AttributeSet, OCDM_Annotation, and OCDM_AnnotationSet.

void releaseObject void   )  const
 

void releaseStoredObject void   )  const
 

void setObject const   CDM_Object  )  const
 

long size void   )  const
 

void storeObject const class OCDM_Object objPtr  )  const
 

const char * toString void   )  const
 

OCDM_BOOL Valid void   )  const
 


Generated on Wed Aug 16 22:32:02 2006 for PythonCDM by  doxygen 1.4.6