FieldIO.h
Go to the documentation of this file.
//----------------------------------------------------------------------------//
/*
* Copyright (c) 2009 Sony Pictures Imageworks Inc
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution. Neither the name of Sony Pictures Imageworks nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
//----------------------------------------------------------------------------//
//----------------------------------------------------------------------------//
#ifndef _INCLUDED_Field3D_FieldIO_H_
#define _INCLUDED_Field3D_FieldIO_H_
//----------------------------------------------------------------------------//
#include <boost/intrusive_ptr.hpp>
#include <string>
#include <map>
#include <list>
#include <hdf5.h>
#include <typeinfo>
#include "Field.h"
#include "OgawaFwd.h"
#include "Log.h"
//----------------------------------------------------------------------------//
#include "ns.h"
FIELD3D_NAMESPACE_OPEN
//----------------------------------------------------------------------------//
// FieldIO
//----------------------------------------------------------------------------//
//----------------------------------------------------------------------------//
class FieldIO : public RefBase
{
public:
// Typedefs ------------------------------------------------------------------
typedef boost::intrusive_ptr<FieldIO> Ptr;
// RTTI replacement ----------------------------------------------------------
typedef FieldIO class_type;
DEFINE_FIELD_RTTI_ABSTRACT_CLASS;
static const char * staticClassType()
{
return "FieldIO";
}
// Ctors, dtor ---------------------------------------------------------------
FieldIO()
: RefBase()
{ }
virtual ~FieldIO() {}
// Methods to be implemented by subclasses -----------------------------------
virtual FieldBase::Ptr read(hid_t layerGroup, const std::string &filename,
const std::string &layerPath,
DataTypeEnum typeEnum) = 0;
virtual FieldBase::Ptr read(const OgIGroup &layerGroup,
const std::string &filename,
const std::string &layerPath,
OgDataType typeEnum) = 0;
virtual bool write(hid_t layerGroup, FieldBase::Ptr field) = 0;
virtual bool write(OgOGroup &layerGroup, FieldBase::Ptr field) = 0;
virtual std::string className() const = 0;
// Strings used when reading/writing -----------------------------------------
private:
// Typedefs ------------------------------------------------------------------
typedef RefBase base;
};
//----------------------------------------------------------------------------//
FIELD3D_NAMESPACE_HEADER_CLOSE
//----------------------------------------------------------------------------//
#endif
Field.h
Contains Field, WritableField and ResizableField classes.
Log.h
Contains the Log class which can be used to redirect output to an arbitrary destination.
OgawaFwd.h
Contains forward declarations for Ogawa classes.
OgDataType
OgDataType
Enumerates the various uses for Ogawa-level groups.
Definition Traits.h:125
DataTypeEnum
DataTypeEnum
Definition Traits.h:108
FieldBase::Ptr
boost::intrusive_ptr< FieldBase > Ptr
Definition Field.h:97
FieldIO::write
virtual bool write(hid_t layerGroup, FieldBase::Ptr field)=0
Write the field to the given layer group.
FieldIO::Ptr
boost::intrusive_ptr< FieldIO > Ptr
Definition FieldIO.h:91
FieldIO::write
virtual bool write(OgOGroup &layerGroup, FieldBase::Ptr field)=0
Write the field to the given layer group.
FieldIO::class_type
FieldIO class_type
Definition FieldIO.h:95
FieldIO::read
virtual FieldBase::Ptr read(hid_t layerGroup, const std::string &filename, const std::string &layerPath, DataTypeEnum typeEnum)=0
Read the field at the given hdf5 group.
FieldIO::read
virtual FieldBase::Ptr read(const OgIGroup &layerGroup, const std::string &filename, const std::string &layerPath, OgDataType typeEnum)=0
Read the field at the given Ogawa group.
FieldIO::FieldIO
FieldIO()
Ctor.
Definition FieldIO.h:106
FieldIO::DEFINE_FIELD_RTTI_ABSTRACT_CLASS
DEFINE_FIELD_RTTI_ABSTRACT_CLASS
Definition FieldIO.h:96
FieldIO::~FieldIO
virtual ~FieldIO()
Dtor.
Definition FieldIO.h:111
FieldIO::className
virtual std::string className() const =0
Returns the class name. This is used when registering the class to the FieldIOFactory object.
FieldIO::base
RefBase base
Convenience typedef for referring to base class.
Definition FieldIO.h:149
FieldIO::staticClassType
static const char * staticClassType()
Definition FieldIO.h:98
RefBase::RefBase
RefBase()
Definition RefCount.h:120
FIELD3D_NAMESPACE_OPEN
Definition FieldMapping.cpp:74
ns.h
FIELD3D_NAMESPACE_HEADER_CLOSE
#define FIELD3D_NAMESPACE_HEADER_CLOSE
Definition ns.h:58