IAttributeWriter Class Reference

Writes an IAttribute to the underlying data storage. More...

Inherited by H5AttributeWriter, and XMLUserMetaDataWriter.

Inheritance diagram for IAttributeWriter:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~IAttributeWriter ()
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::string &value)=0
 Writes an attribute with a string value to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int8 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint8 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int16 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint16 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int32 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint32 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, int64 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, uint64 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, float32 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, float64 value)=0
 Writes an attribute to the underlying data storage mechanism.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int8 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint8 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int16 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint16 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int32 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint32 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< int64 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< uint64 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< float32 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.
virtual int32 writeAttribute (int32 locationId, const std::string &datasetPath, const std::string &key, std::vector< uint64 > &dims, std::vector< float64 > &value)=0
 Writes an attribute to the underlying data storage mechanism where the attribute value is really an array of values.

Protected Member Functions

 IAttributeWriter ()

Detailed Description

Writes an IAttribute to the underlying data storage.

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


Constructor & Destructor Documentation

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

IAttributeWriter::IAttributeWriter (  )  [inline, protected]


Member Function Documentation

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

Writes an attribute with a string value 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int8  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint8  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int16  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint16  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int32  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint32  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
int64  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
uint64  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
float32  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
float64  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int8 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint8 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int16 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint16 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int32 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint32 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int64 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< uint64 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< float32 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.

virtual int32 IAttributeWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< float64 > &  value 
) [pure 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

Implemented in H5AttributeWriter, and XMLUserMetaDataWriter.


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