Celartem::BasicDataArray

Celartem::BasicDataArray Class Reference

#include <cel_dsarray.h>

Inheritance diagram for Celartem::BasicDataArray:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool isValid () const =0
virtual size_t getSize () const =0
virtual u16 getTag () const =0
virtual void setTag (u16 tag)=0
virtual u16 getType () const =0
virtual void setType (u16 type)=0
virtual const void * getVoidPtr () const =0
virtual size_t getAsInt (size_t inIndex) const
virtual double getAsDouble (size_t inIndex) const
virtual TIFF_RATIONAL getAsRational (size_t inIndex) const

Detailed Description

This class defines the basic methods that can be used with any DataArray variations. This class is an abstract class and you should use DataArray.
See also:
DataArray

Definition at line 24 of file cel_dsarray.h.

Member Function Documentation

virtual bool Celartem::BasicDataArray::isValid (  )  const [pure virtual]

This method checks whether the array is valid or not.

Returns:
true if the array is valid, otherwise false.
See also:
SimpleArray::isValid

Implemented in Celartem::DataArray< T >.

virtual size_t Celartem::BasicDataArray::getSize (  )  const [pure virtual]

This method returns the size of array in number of entries.

Returns:
The number of entries.
See also:
SimpleArray::getSize

Implemented in Celartem::DataArray< T >.

virtual u16 Celartem::BasicDataArray::getTag (  )  const [pure virtual]

This method is for compatibility with TIFF 6.0 Specification.

Implemented in Celartem::DataArray< T >.

virtual void Celartem::BasicDataArray::setTag ( u16  tag  )  [pure virtual]

This method is for compatibility with TIFF 6.0 Specification.

Implemented in Celartem::DataArray< T >.

virtual u16 Celartem::BasicDataArray::getType (  )  const [pure virtual]

This method is for compatibility with TIFF 6.0 Specification.

Implemented in Celartem::DataArray< T >.

virtual void Celartem::BasicDataArray::setType ( u16  type  )  [pure virtual]

This method is for compatibility with TIFF 6.0 Specification.

Implemented in Celartem::DataArray< T >.

virtual const void* Celartem::BasicDataArray::getVoidPtr (  )  const [pure virtual]

This method returns const void pointer to the internal data.

Returns:
Pointer to the internal data.

Implemented in Celartem::DataArray< T >.

virtual size_t Celartem::BasicDataArray::getAsInt ( size_t  inIndex  )  const [virtual]

This method returns an entry in the array as size_t value. If the type of the array is not compatible with integral types, this method throws errTypeMismatch.

Parameters:
inIndex The index of the array element.
Returns:
The value.

virtual double Celartem::BasicDataArray::getAsDouble ( size_t  inIndex  )  const [virtual]

This method returns an entry in the array as double value. If the type of the array is not compatible with double type, this method throws errTypeMismatch.

Parameters:
inIndex The index of the array element.
Returns:
The value.

virtual TIFF_RATIONAL Celartem::BasicDataArray::getAsRational ( size_t  inIndex  )  const [virtual]

This method returns an entry in the array as TIFF_RATIONAL value. If the type of the array is not compatible with TIFF_RATIONAL type, this method throws errTypeMismatch.

Parameters:
inIndex The index of the array element.
Returns:
The value.

The documentation for this class was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:16 2008.