OCDM_SpanSet Class Reference

This class handles the use of a set of spans. More...

#include <OCDM.h>

Inheritance diagram for OCDM_SpanSet:

OCDM_Object List of all members.

Public Member Functions

 OCDM_SpanSet ()
 OCDM_SpanSet (const CDM_Object obj)
 OCDM_SpanSet (const class OCDM_SpanSet &obj)
 OCDM_SpanSet (const long start, const long end)
 This function will create a new SpanSet object.
OCDM_SpanSetoperator= (const class OCDM_Object &obj)
 This is the default assignment operator.
 OCDM_INDEX_OPERATOR_REF (OCDM_Span) operator[](const long index) const
void AddSpan (const OCDM_Span &Span)
 It appends the given Span to the Span set object in use.
const char * objectType (void) const

Detailed Description

Description:
This class handles the use of a set of spans. It can be used to create sets of spans, to append a span into a set, etc...


Constructor & Destructor Documentation

OCDM_SpanSet (  )  [inline]

OCDM_SpanSet ( const CDM_Object  obj  )  [inline]

OCDM_SpanSet ( const class OCDM_SpanSet obj  )  [inline]

OCDM_SpanSet ( const long  start,
const long  end 
)

Description:
The newly created spanset object will contain a single Span object (of type OCDM_Span) with the specified start and end values.
Arguments:
  • start: The starting value of the span object.
  • end: The ending value of the span object.
Note:
In case of an error, an exception of type OCDM_Exception will be thrown.


Member Function Documentation

class OCDM_SpanSet& operator= ( const class OCDM_Object obj  )  [inline, 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 from OCDM_Object.

OCDM_INDEX_OPERATOR_REF ( OCDM_Span   )  const

void AddSpan ( const OCDM_Span obj  ) 

Arguments:
  • Span: The span object to be appended to the span set object in use.
Note:
In case of an error, an exception of type OCDM_Exception will be thrown.

const char* objectType ( void   )  const [inline, virtual]

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

Reimplemented from OCDM_Object.


Generated on Tue Jun 26 17:40:45 2007 for PerlCDM by  doxygen 1.5.2