afl::ddf::PropertySet Class Reference

#include <propertyset.h>

List of all members.

Public Member Functions

 PropertySet ()
 PropertySet (const PropertySet &toCopy)
PropertySetoperator= (const PropertySet &toCopy)
 ~PropertySet ()
void save (const std::string &dir) const
PropertyloadPoints (const std::string &path)
PropertyinitPoints (const Geometry *geom)
PropertyloadValues (const std::string &path)
PropertyinitValues (const Geometry *geom)
PropertyloadJacobian (const std::string &path)
PropertyinitJacobian (const Geometry *geom)
const PropertygetPoints () const
const PropertygetValues () const
const PropertygetJacobian () const
PropertygetPoints ()
PropertygetValues ()
PropertygetJacobian ()
VNode getVNode (size_t loc)
VNode getVNode (size_t loc) const


Detailed Description

A container that holds three numeric properties: points, values and Jacobian


Constructor & Destructor Documentation

afl::ddf::PropertySet::PropertySet  ) 
 

Empty Constructor

afl::ddf::PropertySet::PropertySet const PropertySet toCopy  ) 
 

copy constructor

Parameters:
toCopy the property set to copy

afl::ddf::PropertySet::~PropertySet  ) 
 

Destructor


Member Function Documentation

Property* afl::ddf::PropertySet::getJacobian  )  [inline]
 

Returns:
a pointer to the Jacobian property. If the property is neither loaded nor initialised, NULL is returned.

const Property* afl::ddf::PropertySet::getJacobian  )  const [inline]
 

Returns:
a pointer to the Jacobian property. If the property is neither loaded nor initialised, NULL is returned.

Property* afl::ddf::PropertySet::getPoints  )  [inline]
 

Returns:
a pointer to the points property. If the property is neither loaded nor initialised, NULL is returned.

const Property* afl::ddf::PropertySet::getPoints  )  const [inline]
 

Returns:
a pointer to the points property. If the property is neither loaded nor initialised, NULL is returned.

Property* afl::ddf::PropertySet::getValues  )  [inline]
 

Returns:
a pointer to the values property. If the property is neither loaded nor initialised, NULL is returned.

const Property* afl::ddf::PropertySet::getValues  )  const [inline]
 

Returns:
a pointer to the values property. If the property is neither loaded nor initialised, NULL is returned.

VNode afl::ddf::PropertySet::getVNode size_t  loc  )  const
 

creates a constant VNode iterator for position index loc

Parameters:
loc the location this VNode would point to

VNode afl::ddf::PropertySet::getVNode size_t  loc  ) 
 

creates a VNode iterator for position index loc

Parameters:
loc the location this VNode would point to

Property* afl::ddf::PropertySet::initJacobian const Geometry geom  ) 
 

creates a new empty Jacobian property

Parameters:
geom the geometry of the nodes in the proprety return a pointer to the newly created property

Property* afl::ddf::PropertySet::initPoints const Geometry geom  ) 
 

creates a new empty points property

Parameters:
geom the geometry of the nodes in the proprety return a pointer to the newly created property

Property* afl::ddf::PropertySet::initValues const Geometry geom  ) 
 

creates a new empty values property

Parameters:
geom the geometry of the nodes in the proprety return a pointer to the newly created property

Property* afl::ddf::PropertySet::loadJacobian const std::string &  path  ) 
 

loads the Jacobian property from a .h5 file

Parameters:
path the location of the .h5 file
Returns:
a pointer to the newly loaded property or NULL if it didn't load

Property* afl::ddf::PropertySet::loadPoints const std::string &  path  ) 
 

loads the points property from a .h5 file

Parameters:
path the location of the .h5 file
Returns:
a pointer to the newly loaded property or NULL if it didn't load

Property* afl::ddf::PropertySet::loadValues const std::string &  path  ) 
 

loads the values property from a .h5 file

Parameters:
path the location of the .h5 file
Returns:
a pointer to the newly loaded property or NULL if it didn't load

PropertySet& afl::ddf::PropertySet::operator= const PropertySet toCopy  ) 
 

assignment operator

Parameters:
toCopy the property set to copy
Returns:
a reference to this property set

void afl::ddf::PropertySet::save const std::string &  dir  )  const
 

saves all initialised/loaded properties as .h5 files in a directory

Parameters:
dir the directory to save it in
Exceptions:
exc::IOException if the directory can't be written to


The documentation for this class was generated from the following file:
Generated on Fri Dec 22 07:17:52 2006 for afl by  doxygen 1.4.6