Field3D
FieldMappingIO Class Reference

#include <FieldMappingIO.h>

Inheritance diagram for FieldMappingIO:
RefBase FrustumFieldMappingIO MatrixFieldMappingIO NullFieldMappingIO

List of all members.

Public Types

typedef FieldMappingIO class_type
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.
 FieldMappingIO ()
 Ctor.
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 ~FieldMappingIO ()
 Dtor.

Static Public Member Functions

static const char * classType ()
 RTTI replacement.

Public Attributes

 DEFINE_FIELD_RTTI_ABSTRACT_CLASS

Private Types

typedef RefBase base
 Convenience typedef for referring to base class.

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, and FrustumFieldMappingIO.

Definition at line 70 of file FieldMappingIO.h.

typedef RefBase FieldMappingIO::base [private]

Convenience typedef for referring to base class.

Reimplemented in NullFieldMappingIO, MatrixFieldMappingIO, and FrustumFieldMappingIO.

Definition at line 114 of file FieldMappingIO.h.


Constructor & Destructor Documentation

FieldMappingIO::FieldMappingIO ( ) [inline]

Ctor.

Definition at line 86 of file FieldMappingIO.h.

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

Dtor.

Definition at line 91 of file FieldMappingIO.h.

  { }

Member Function Documentation

static const char* FieldMappingIO::classType ( ) [inline, static]

RTTI replacement.

Reimplemented from RefBase.

Reimplemented in NullFieldMappingIO, MatrixFieldMappingIO, and FrustumFieldMappingIO.

Definition at line 78 of file FieldMappingIO.h.

  {
    return "FieldMappingIO";
  }
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, and FrustumFieldMappingIO.

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, and FrustumFieldMappingIO.

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, and FrustumFieldMappingIO.


Member Data Documentation


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