Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members   Examples  

Axis_Array Class Reference

#include <AxisUserAPI.hpp>

Inheritance diagram for Axis_Array:

List of all members.

Public Methods

 Axis_Array ()
 Axis_Array (const Axis_Array &original)
virtual ~Axis_Array ()
void clone (const Axis_Array &original)
virtual Axis_Array * clone () const
void set (void **array, int size, XSDTYPE type)
void ** get (int &size, XSDTYPE &type) const
void clear ()
void addElement (void *element)

Protected Attributes

void ** m_Array
int m_Size
XSDTYPE m_Type
bool m_belongsToAxisEngine

Detailed Description

The parent storage class for arrays


Constructor & Destructor Documentation

Axis_Array::Axis_Array  
 

Constructor

Axis_Array::Axis_Array const Axis_Array &    original
 

Copy constructor

Parameters:
orginal  Axis_Array to copy.

virtual Axis_Array::~Axis_Array   [virtual]
 

Destructor


Member Function Documentation

void Axis_Array::addElement void *    element
 

Add an additional element to the array.

Parameters:
element  to be added to the array. This will be appended to the end of the existing array.

void Axis_Array::clear  
 

Clear the array, and it's data

virtual Axis_Array* Axis_Array::clone   [virtual]
 

Create a new clone of the current Axis_Array

Returns:
New clone of the current Axis_Array.

void Axis_Array::clone const Axis_Array &    original
 

Clone the content of an existing Axis_Array

Parameters:
original  array to be cloned into this array.

void** Axis_Array::get int &    size,
XSDTYPE &    type
const
 

Return a c-style array.

Parameters:
size, this  will be updated with the size of the array returned.
type, this  will be updated with the type of the data returned.
Returns:
c-style array of pointers to the array data.

void Axis_Array::set void **    array,
int    size,
XSDTYPE    type
 

Populate from a c-style array.

Parameters:
array  is a c-style array of pointers to the array data.
size  of the array, including NULL entries.
type  of data.


Member Data Documentation

void** Axis_Array::m_Array [protected]
 

Array of pointers to array elements

bool Axis_Array::m_belongsToAxisEngine [protected]
 

Indicates if array was created by the engine and therefore needs to be destroyed by the engine.

int Axis_Array::m_Size [protected]
 

Size of array

XSDTYPE Axis_Array::m_Type [protected]
 

XSD datatype within this array


The documentation for this class was generated from the following file:
Generated on Fri Mar 3 01:12:36 2006 for AxisC++ by doxygen1.2.18