Field3D
FieldMappingIO Class Referenceabstract

#include <FieldMappingIO.h>

Inheritance diagram for FieldMappingIO:
RefBase FrustumFieldMappingIO MatrixFieldMappingIO NullFieldMappingIO

Public Types

typedef FieldMappingIO class_type
 
typedef boost::intrusive_ptr< FieldMappingIOPtr
 
- Public Types inherited from RefBase
typedef boost::intrusive_ptr< RefBasePtr
 
typedef boost::weak_ptr< RefBaseWeakPtr
 

Public Member Functions

virtual std::string className () const =0
 Returns the class name. This is used when registering the class in the ClassFactory. More...
 
 FieldMappingIO ()
 Ctor. More...
 
virtual FieldMapping::Ptr read (const OgIGroup &mappingGroup)=0
 Read the field at the given hdf5 group. More...
 
virtual FieldMapping::Ptr read (hid_t mappingGroup)=0
 Read the field at the given hdf5 group. More...
 
virtual bool write (hid_t mappingGroup, FieldMapping::Ptr mapping)=0
 Write the field to the given mapping group. More...
 
virtual bool write (OgOGroup &mappingGroup, FieldMapping::Ptr mapping)=0
 Write the field to the given mapping group. More...
 
virtual ~FieldMappingIO ()
 Dtor. More...
 
- Public Member Functions inherited from RefBase
void ref () const
 Used by boost::intrusive_pointer. More...
 
size_t refcnt ()
 Used by boost::intrusive_pointer. More...
 
void unref () const
 Used by boost::intrusive_pointer. More...
 
WeakPtr weakPtr () const
 
 RefBase ()
 
 RefBase (const RefBase &)
 Copy constructor. More...
 
RefBaseoperator= (const RefBase &)
 Assignment operator. More...
 
virtual ~RefBase ()
 Destructor. More...
 
virtual bool checkRTTI (const char *typenameStr)=0
 This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. More...
 
bool matchRTTI (const char *typenameStr)
 Performs a check to see if the given typename string matches this class' This needs to be implemented in -all- subclasses, even abstract ones. More...
 

Static Public Member Functions

static const char * staticClassType ()
 RTTI replacement. More...
 
- Static Public Member Functions inherited from RefBase
static const char * staticClassType ()
 

Public Attributes

 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 

Private Types

typedef RefBase base
 Convenience typedef for referring to base class. More...
 

Detailed Description

Definition at line 64 of file FieldMappingIO.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 71 of file FieldMappingIO.h.

◆ class_type

Definition at line 75 of file FieldMappingIO.h.

◆ base

typedef RefBase FieldMappingIO::base
private

Convenience typedef for referring to base class.

Definition at line 124 of file FieldMappingIO.h.

Constructor & Destructor Documentation

◆ FieldMappingIO()

FieldMappingIO::FieldMappingIO ( )
inline

Ctor.

Definition at line 87 of file FieldMappingIO.h.

88  : RefBase()
89  { }

◆ ~FieldMappingIO()

virtual FieldMappingIO::~FieldMappingIO ( )
inlinevirtual

Dtor.

Definition at line 92 of file FieldMappingIO.h.

93  { }

Member Function Documentation

◆ staticClassType()

static const char* FieldMappingIO::staticClassType ( )
inlinestatic

RTTI replacement.

Definition at line 79 of file FieldMappingIO.h.

80  {
81  return "FieldMappingIO";
82  }

◆ read() [1/2]

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

◆ read() [2/2]

virtual FieldMapping::Ptr FieldMappingIO::read ( const OgIGroup &  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 FrustumFieldMappingIO, MatrixFieldMappingIO, and NullFieldMappingIO.

◆ write() [1/2]

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

◆ write() [2/2]

virtual bool FieldMappingIO::write ( OgOGroup &  mappingGroup,
FieldMapping::Ptr  mapping 
)
pure virtual

Write the field to the given mapping group.

Returns
Whether the operation was successful

Implemented in FrustumFieldMappingIO, MatrixFieldMappingIO, and NullFieldMappingIO.

◆ className()

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

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

Implemented in FrustumFieldMappingIO, MatrixFieldMappingIO, and NullFieldMappingIO.

Member Data Documentation

◆ DEFINE_FIELD_RTTI_ABSTRACT_CLASS

FieldMappingIO::DEFINE_FIELD_RTTI_ABSTRACT_CLASS

Definition at line 76 of file FieldMappingIO.h.


The documentation for this class was generated from the following file:
RefBase::RefBase
RefBase()
Definition: RefCount.h:120