IMXAArray Class Reference

This class holds a raw pointer to some allocated data that can be stored into or read from an HDF5 data file. The class design was borrowed heavily from the vtkDataArray class from www.vtk.org. The work was all performed by those individuals. I have merely changed a few methods to meet my specific needs. More...

Inherited by MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

Inheritance diagram for IMXAArray:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 MXA_SHARED_POINTERS (IMXAArray)
 IMXAArray ()
virtual ~IMXAArray ()
virtual void takeOwnership ()=0
 Makes this class responsible for freeing the memory.
virtual void releaseOwnership ()=0
 This class will NOT free the memory associated with the internal pointer. This can be useful if the user wishes to keep the data around after this class goes out of scope.
virtual void * getVoidPointer (uint64 i)=0
 Returns a void pointer pointing to the index of the array. NULL pointers are entirely possible. No checks are performed to make sure the index is with in the range of the internal data array.
virtual uint64 getNumberOfElements ()=0
 Returns the number of elements in the internal array.
virtual int32 getNumberOfDimensions ()=0
virtual void getDimensions (uint64 *dims)=0
 Copies the values of the dimensions into the supplied pointer.
virtual int32 getDataType ()=0
 Returns an enumerated type that can be used to find out the type of primitive stored in the internal array.
virtual size_t getTypeSize ()=0
 Returns the number of bytes that make up the data type. 1 = char 2 = 16 bit integer 4 = 32 bit integer/Float 8 = 64 bit integer/Double.
virtual void byteSwapElements ()=0
 Byte swaps the Elements in the array. Needed if you want to convert the endianess of the data.
virtual void initializeWithZeros ()=0
 Sets all the values to zero.
virtual void printSelf (std::ostream &os, int32 indent)=0
 Prints information about the class to ostream.
virtual std::string valueToString (char delimiter)=0
 Converts the data array into a string delimited by the supplied delimiter.
virtual int32 exportToFile (DataExportProperties::Pointer expProps)=0
 Saves the array to an external file on the system.

Private Member Functions

 IMXAArray (const IMXAArray &)
void operator= (const IMXAArray &)

Detailed Description

This class holds a raw pointer to some allocated data that can be stored into or read from an HDF5 data file. The class design was borrowed heavily from the vtkDataArray class from www.vtk.org. The work was all performed by those individuals. I have merely changed a few methods to meet my specific needs.

Author:
mjackson
Date:
Jan 3, 2008
Version:
Revision
1.2


Constructor & Destructor Documentation

IMXAArray::IMXAArray (  )  [inline]

virtual IMXAArray::~IMXAArray (  )  [inline, virtual]

IMXAArray::IMXAArray ( const IMXAArray  )  [private]


Member Function Documentation

IMXAArray::MXA_SHARED_POINTERS ( IMXAArray   ) 

virtual void IMXAArray::takeOwnership (  )  [pure virtual]

Makes this class responsible for freeing the memory.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual void IMXAArray::releaseOwnership (  )  [pure virtual]

This class will NOT free the memory associated with the internal pointer. This can be useful if the user wishes to keep the data around after this class goes out of scope.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual void* IMXAArray::getVoidPointer ( uint64  i  )  [pure virtual]

Returns a void pointer pointing to the index of the array. NULL pointers are entirely possible. No checks are performed to make sure the index is with in the range of the internal data array.

Parameters:
i The index to have the returned pointer pointing to.
Returns:
Void Pointer. Possibly NULL.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual uint64 IMXAArray::getNumberOfElements (  )  [pure virtual]

Returns the number of elements in the internal array.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual int32 IMXAArray::getNumberOfDimensions (  )  [pure virtual]

Returns the number of dimensions the data has.

Implemented in MXA2DArray< T >, MXAArrayTemplate< T >, MXARGBImage, and MXAArrayTemplate< uint8 >.

virtual void IMXAArray::getDimensions ( uint64 *  dims  )  [pure virtual]

Copies the values of the dimensions into the supplied pointer.

Parameters:
dims 

Implemented in MXA2DArray< T >, MXAArrayTemplate< T >, MXARGBImage, and MXAArrayTemplate< uint8 >.

virtual int32 IMXAArray::getDataType (  )  [pure virtual]

Returns an enumerated type that can be used to find out the type of primitive stored in the internal array.

Implemented in MXAArrayTemplate< T >, MXAAsciiStringData, and MXAArrayTemplate< uint8 >.

virtual size_t IMXAArray::getTypeSize (  )  [pure virtual]

Returns the number of bytes that make up the data type. 1 = char 2 = 16 bit integer 4 = 32 bit integer/Float 8 = 64 bit integer/Double.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual void IMXAArray::byteSwapElements (  )  [pure virtual]

Byte swaps the Elements in the array. Needed if you want to convert the endianess of the data.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual void IMXAArray::initializeWithZeros (  )  [pure virtual]

Sets all the values to zero.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual void IMXAArray::printSelf ( std::ostream &  os,
int32  indent 
) [pure virtual]

Prints information about the class to ostream.

Parameters:
os 
indent 

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

virtual std::string IMXAArray::valueToString ( char  delimiter  )  [pure virtual]

Converts the data array into a string delimited by the supplied delimiter.

Parameters:
delimiter The delimiter to use between each value
Returns:
The generated string

Implemented in MXA2DArray< T >, MXAArrayTemplate< T >, MXAAsciiStringData, MXARGBImage, and MXAArrayTemplate< uint8 >.

virtual int32 IMXAArray::exportToFile ( DataExportProperties::Pointer  expProps  )  [pure virtual]

Saves the array to an external file on the system.

Parameters:
expProps The properties to use when saving the array
Returns:
Error code.

Implemented in MXAArrayTemplate< T >, and MXAArrayTemplate< uint8 >.

void IMXAArray::operator= ( const IMXAArray  )  [private]


The documentation for this class was generated from the following file:
Generated on Tue Nov 17 18:43:14 2009 for MXADataModel by  doxygen 1.5.2