XMLUserMetaDataWriter Class Reference

This class writes User meta data from the data model to an xml file. More...

Inherits IAttributeWriter.

Inheritance diagram for XMLUserMetaDataWriter:

Inheritance graph
[legend]
Collaboration diagram for XMLUserMetaDataWriter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 XMLUserMetaDataWriter (boost::shared_ptr< std::ofstream > ofstreamPtr)
virtual ~XMLUserMetaDataWriter ()
std::string indent (int depth)
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 an attribute with a string value to the underlying data storage mechanism.
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 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< 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.

Private Member Functions

 XMLUserMetaDataWriter (const XMLUserMetaDataWriter &)
void operator= (const XMLUserMetaDataWriter &)

Private Attributes

boost::shared_ptr< std::ofstream > _ofstreamPtr

Detailed Description

This class writes User meta data from the data model to an xml file.

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


Constructor & Destructor Documentation

XMLUserMetaDataWriter::XMLUserMetaDataWriter ( boost::shared_ptr< std::ofstream >  ofstreamPtr  )  [inline]

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

XMLUserMetaDataWriter::XMLUserMetaDataWriter ( const XMLUserMetaDataWriter  )  [private]


Member Function Documentation

std::string XMLUserMetaDataWriter::indent ( int  depth  )  [inline]

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

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

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

Implements IAttributeWriter.

int32 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::writeAttribute ( int32  locationId,
const std::string &  datasetPath,
const std::string &  key,
std::vector< uint64 > &  dims,
std::vector< int8 > &  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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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 XMLUserMetaDataWriter::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.

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


Member Data Documentation

boost::shared_ptr<std::ofstream> XMLUserMetaDataWriter::_ofstreamPtr [private]


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