Field3D
FieldMappingIO Class Reference

#include <FieldMappingIO.h>

Inheritance diagram for FieldMappingIO:
RefBase RefBase MatrixFieldMappingIO MatrixFieldMappingIO NullFieldMappingIO NullFieldMappingIO

List of all members.

Public Types

typedef boost::intrusive_ptr
< FieldMappingIO
Ptr
typedef boost::intrusive_ptr
< FieldMappingIO
Ptr

Public Member Functions

virtual std::string className () const =0
 Returns the class name. This is used when registering the class in the ClassFactory.
virtual std::string className () const =0
 Returns the class name. This is used when registering the class in the ClassFactory.
 FieldMappingIO ()
 Ctor.
 FieldMappingIO ()
 Ctor.
virtual FieldMapping::Ptr read (hid_t mappingGroup)=0
 Read the field at the given hdf5 group.
virtual FieldMapping::Ptr read (hid_t mappingGroup)=0
 Read the field at the given hdf5 group.
virtual bool write (hid_t mappingGroup, FieldMapping::Ptr mapping)=0
 Write the field to the given mapping group.
virtual bool write (hid_t mappingGroup, FieldMapping::Ptr mapping)=0
 Write the field to the given mapping group.
virtual ~FieldMappingIO ()
 Dtor.
virtual ~FieldMappingIO ()
 Dtor.

Detailed Description

Definition at line 63 of file FieldMappingIO.h.


Member Typedef Documentation

typedef boost::intrusive_ptr<FieldMappingIO> FieldMappingIO::Ptr

Reimplemented from RefBase.

Reimplemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

Definition at line 70 of file FieldMappingIO.h.

typedef boost::intrusive_ptr<FieldMappingIO> FieldMappingIO::Ptr

Reimplemented from RefBase.

Reimplemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

Definition at line 70 of file FieldMappingIO.h.


Constructor & Destructor Documentation

FieldMappingIO::FieldMappingIO ( ) [inline]

Ctor.

Definition at line 75 of file FieldMappingIO.h.

: RefBase() {}
virtual FieldMappingIO::~FieldMappingIO ( ) [inline, virtual]

Dtor.

Definition at line 78 of file FieldMappingIO.h.

{}
FieldMappingIO::FieldMappingIO ( ) [inline]

Ctor.

Definition at line 75 of file FieldMappingIO.h.

: RefBase() {}
virtual FieldMappingIO::~FieldMappingIO ( ) [inline, virtual]

Dtor.

Definition at line 78 of file FieldMappingIO.h.

{}

Member Function Documentation

virtual FieldMapping::Ptr FieldMappingIO::read ( hid_t  mappingGroup) [pure virtual]

Read the field at the given hdf5 group.

Returns:
Pointer to the created field, or a null pointer if the field couldn't be read.

Implemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

virtual bool FieldMappingIO::write ( hid_t  mappingGroup,
FieldMapping::Ptr  mapping 
) [pure virtual]

Write the field to the given mapping group.

Returns:
Whether the operation was successful

Implemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

virtual std::string FieldMappingIO::className ( ) const [pure virtual]

Returns the class name. This is used when registering the class in the ClassFactory.

Implemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

virtual FieldMapping::Ptr FieldMappingIO::read ( hid_t  mappingGroup) [pure virtual]

Read the field at the given hdf5 group.

Returns:
Pointer to the created field, or a null pointer if the field couldn't be read.

Implemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

virtual bool FieldMappingIO::write ( hid_t  mappingGroup,
FieldMapping::Ptr  mapping 
) [pure virtual]

Write the field to the given mapping group.

Returns:
Whether the operation was successful

Implemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.

virtual std::string FieldMappingIO::className ( ) const [pure virtual]

Returns the class name. This is used when registering the class in the ClassFactory.

Implemented in NullFieldMappingIO, MatrixFieldMappingIO, NullFieldMappingIO, and MatrixFieldMappingIO.


The documentation for this class was generated from the following files: