H5AttributeWriter Class Reference

Writes Attributes for a dataset to an HDF5 data file. More...

Inherits IAttributeWriter.

Inheritance diagram for H5AttributeWriter:

Inheritance graph
[legend]
Collaboration diagram for H5AttributeWriter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 H5AttributeWriter ()
virtual ~H5AttributeWriter ()
template<typename T>
int32 _writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, T value)
template<typename T>
int32 _writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< T > &value)
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::string &value)
 Writes a Scalar Attribute value for a given dataset.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int8 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint8 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int16 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint16 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int32 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint32 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int64 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint64 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, float32 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, float64 value)
 Writes an attribute to the underlying data storage mechanism.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int8 > &value)
 Writes a Vector/Matrix Attribute value for a given dataset.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint8 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int16 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint16 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int32 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint32 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int64 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint64 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< float32 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< float64 > &value)
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Detailed Description

Writes Attributes for a dataset to an HDF5 data file.

Author:
Mike Jackson
Version:
Revision
1.2
Date:
March 2007


Constructor & Destructor Documentation

H5AttributeWriter::H5AttributeWriter (  )  [inline]

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


Member Function Documentation

template<typename T>
int32 H5AttributeWriter::_writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
value 
) [inline]

template<typename T>
int32 H5AttributeWriter::_writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< T > &  value 
) [inline]

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::string &  value 
) [inline, virtual]

Writes a Scalar Attribute value for a given dataset.

Parameters:
locationId An HDF5 id the represents a file or group that contains the dataset
datasetPath The Path to the dataset that the attribute is going to be written to
key The Key for the Attribute
value The Value of the Attribute
Returns:
Standard HDF5 Error condition.

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int8  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint8  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int16  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint16  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int32  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint32  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int64  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint64  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
float32  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
float64  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int8 > &  value 
) [inline, virtual]

Writes a Vector/Matrix Attribute value for a given dataset.

Parameters:
locationId An HDF5 id the represents a file or group that contains the dataset
datasetPath The Path to the dataset that the attribute is going to be written to
key The Key for the Attribute
dims The dimensions of the data set
value The Value of the Attribute
Returns:
Standard HDF5 Error condition.

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint8 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int16 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint16 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int32 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint32 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int64 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint64 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< float32 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.

int32 H5AttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< float64 > &  value 
) [inline, virtual]

Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Parameters:
locationId Unique location or file identifier
datasetPath The Path to the dataset
key The Attribute key
dims The size of each dimension for this array based attribute
value The value of the Attribute
Returns:
Error condition. Negative=Error: Zero or Positive=Success

Implements IAttributeWriter.


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