OCDM_Span Class Reference

#include <OCDM.h>

Inheritance diagram for OCDM_Span:

OCDM_Object List of all members.

Public Member Functions

 OCDM_Span ()
 OCDM_Span (const CDM_Object obj)
 OCDM_Span (const class OCDM_Span &obj)
 OCDM_Span (const long start, const long end)
 This function will create a Span object having the start and end values defined in the parameters.
OCDM_Spanoperator= (const class OCDM_Object &obj)
 This is the default assignment operator.
long GetStart (void) const
 This function returns the start of the span object in use.
long GetEnd (void) const
 This function returns the end of the span object in use.
int GetSpanOffsets (long &start, long &end) const
const char * objectType (void) const

Detailed Description

This class incorporates every function related to the use of Spans


Constructor & Destructor Documentation

OCDM_Span  )  [inline]
 

OCDM_Span const CDM_Object  obj  )  [inline]
 

OCDM_Span const class OCDM_Span obj  )  [inline]
 

OCDM_Span const long  start,
const long  end
 

Description:
This function will create a Span object having a start and an end value defined in the parameters. Bare in mind that each span object is a set of exactly two integers, named as "start" and "end". In case of an error, an Exception of type OCDM_Exception will be thrown and a message will be left at the current active Tcl interpreter (CDM_Interp).
Arguments:
  • start: The starting value of the Span object to be created.
  • end: The ending value of the Span object to be created.


Member Function Documentation

long GetEnd void   )  const
 

Description:
This function returns the ending value of the span object in use. It takes no other parameters.

int GetSpanOffsets long &  start,
long &  end
const
 

This function will place the values of the both span start and end of the span object in use, in the two specified long integer pointers.

long GetStart void   )  const
 

Description:
This function returns the starting value of the span object in use. It takes no other parameters.

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

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

Reimplemented from OCDM_Object.

class OCDM_Span& 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.


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