frepple::Location Class Reference

This abstract class is used to associate buffers and resources with a physical location. More...

#include <model.h>

Inheritance diagram for frepple::Location:
frepple::utils::HasHierarchy< Location > frepple::utils::HasDescription frepple::utils::Object frepple::utils::HasName< Location > frepple::utils::NonCopyable frepple::utils::Tree::TreeNode frepple::LocationDefault

List of all members.

Public Member Functions

void beginElement (XMLInput &, const Attribute &)
void endElement (XMLInput &, const Attribute &, const DataElement &)
size_t extrasize () const
CalendarBoolgetAvailable () const
virtual const MetaClassgetType () const
 Location (const string &n)
void setAvailable (CalendarBool *b)
void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
virtual ~Location ()

Static Public Attributes

static const MetaCategorymetadata

Detailed Description

This abstract class is used to associate buffers and resources with a physical location.

Locations are useful for reporting.
The 'available' calendar is used to model the working hours and holidays of resources, buffers and operations.

Definition at line 1322 of file model.h.


Constructor & Destructor Documentation

frepple::Location::Location ( const string &  n  )  [inline, explicit]

Constructor.

Definition at line 1327 of file model.h.

frepple::Location::~Location (  )  [virtual]

Destructor.

Definition at line 89 of file location.cpp.


Member Function Documentation

void frepple::Location::beginElement ( XMLInput ,
const Attribute  
) [virtual]

Called while restoring the model from an XML-file.
This is called for each element within the "this" element, for which the "this" element is immediate parent.
It is called when the open element tag is encountered.

Reimplemented from frepple::utils::Object.

Definition at line 56 of file location.cpp.

void frepple::Location::endElement ( XMLInput ,
const Attribute ,
const DataElement  
) [virtual]

Called while restoring the model from an XML-file.
This is called when the corresponding close element tag is encountered, and the Data() member of pElement is valid.

Implements frepple::utils::Object.

Definition at line 65 of file location.cpp.

size_t frepple::Location::extrasize (  )  const [inline]

Returns the memory size in bytes.

Reimplemented from frepple::utils::HasDescription.

Definition at line 1344 of file model.h.

CalendarBool* frepple::Location::getAvailable (  )  const [inline]

Returns the availability calendar of the location.
The availability calendar models the working hours and holidays. It applies to all operations, resources and buffers using this location.

Definition at line 1336 of file model.h.

virtual const MetaClass& frepple::Location::getType (  )  const [inline, virtual]

This returns the type information on the object, a bit similar to the standard type_info information.

Implements frepple::utils::Object.

Reimplemented in frepple::LocationDefault.

Definition at line 1346 of file model.h.

void frepple::Location::setAvailable ( CalendarBool b  )  [inline]

Updates the availability calend of the location.

Definition at line 1339 of file model.h.

void frepple::Location::writeElement ( XMLOutput ,
const Keyword ,
mode  = DEFAULT 
) const [virtual]

Called while writing the model into an XML-file. The user class should write itself out, using the IOutStream members for its "simple" members and calling writeElement recursively for any contained objects. Not all classes are expected to implement this method. In instances of such a class can be created but can't be persisted. E.g. Command

Reimplemented from frepple::utils::Object.

Definition at line 36 of file location.cpp.


Member Data Documentation

Reimplemented in frepple::LocationDefault.

Definition at line 1347 of file model.h.


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

Generated on 25 Feb 2010 for frePPLe by  doxygen 1.6.1