afl::FieldFactory Class Reference

#include <fieldfactory.h>

List of all members.

Public Member Functions
	FieldFactory ()
virtual	~FieldFactory ()
Field *	load (const std::string &fullPath) const
Field *	load (const std::string &path, const std::string &name) const
Field *	loadFieldURI (const std::string &uri, XMLParser *parser=NULL) const
void	save (const std::string &path, const Field *field, const std::string &baseURI="") const
Field *	getNewField (const std::string &name, size_t dim) const
Field *	getNewField (const std::string &name, std::vector< const Field * > fields, std::vector< std::string > functions, size_t columns=1)

---

Detailed Description

a structure that instantiates field objects. It can read FRL fields from disk, or create new ones. It also saves fields to FRL.

---

Constructor & Destructor Documentation

afl::FieldFactory::FieldFactory (   )  [inline]

empty constructor

virtual afl::FieldFactory::~FieldFactory (   )  [inline, virtual]

destructor

---

Member Function Documentation

Field* afl::FieldFactory::getNewField (  const std::string &  name, std::vector< const Field * >  fields, std::vector< std::string >  functions, size_t  columns = 1 )

creates a composite field from other fields and from formulas Parameters: name  the name of the new composite fields  the fields to compose functions  the functions that compose the fields together columns  the number of columns in the value type (default is 1)

Field* afl::FieldFactory::getNewField (  const std::string &  name, size_t  dim )  const

creates a blank field Parameters: name  the name of the field dim  the number of dimensions in the field

Field* afl::FieldFactory::load (  const std::string &  path, const std::string &  name )  const

loads a field from file Parameters: path  the path to the directory that contains the .afl directory name  the name of the field Returns: a new field object according to the description in the FRL file Exceptions: ddf::IOException  if an I/O exception occurs

Field* afl::FieldFactory::load (  const std::string &  fullPath  )  const

loads a field from file Parameters: fullPath  the path to the .afl directory to load Returns: a new field object according to the description in the FRL file Exceptions: ddf::IOException  if an I/O exception occurs

Field* afl::FieldFactory::loadFieldURI (  const std::string &  uri, XMLParser *  parser = NULL )  const

creates a field from a URI. Parameters: uri  a URI pointing to a field XML parser  (optional) an XML parser Returns: a pointer to a newly allocated field object.

void afl::FieldFactory::save (  const std::string &  path, const Field *  field, const std::string &  baseURI = "" )  const

saves a field to a file Parameters: path  the path to the directory that will contain the .afl directory field  the field to save baseURI  an optional argument that represents the URI to access the saved field and its components Exceptions: ddf::IOException  if an I/O exception occurs

---

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

• fieldfactory.h

---