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

#include <model.h>

Inheritance diagram for frepple::Location:

List of all members.

Public Member Functions

void beginElement (XMLInput &, const Attribute &)
void endElement (XMLInput &, const Attribute &, const DataElement &)
size_t extrasize () const
virtual PyObject * getattro (const Attribute &)
CalendarDoublegetAvailable () const
virtual const MetaClassgetType () const
 Location (const string &n)
virtual int setattro (const Attribute &, const PythonObject &)
void setAvailable (CalendarDouble *b)
void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
virtual ~Location ()
- Public Member Functions inherited from frepple::utils::HasHierarchy< Location >
memberIterator beginMember () const
unsigned short getHierarchyLevel () const
LocationgetOwner () const
 HasHierarchy (const string &n)
bool hasOwner () const
bool isGroup () const
void setOwner (Location *f)
 ~HasHierarchy ()
- Public Member Functions inherited from frepple::utils::HasName< Location >
int compare (const PyObject *other) const
 HasName (const string &n)
 HasName (const char *n)
void setName (const string &newname)
virtual PyObject * str () const
 ~HasName ()
- Public Member Functions inherited from frepple::utils::Tree::TreeNode
TreeNodedecrement () const
const string & getName () const
TreeNodeincrement () const
bool operator< (const TreeNode &o)
 TreeNode (const string &n)
virtual ~TreeNode ()
- Public Member Functions inherited from frepple::utils::Object
virtual bool getHidden () const
virtual size_t getSize () const =0
 Object ()
virtual void setHidden (bool b)
virtual ~Object ()
- Public Member Functions inherited from frepple::utils::PythonExtensionBase
virtual PyObject * call (const PythonObject &args, const PythonObject &kwds)
Py_ssize_t getReferenceCount () const
void initType (const MetaClass *t)
void initType (PyTypeObject *t)
virtual PyObject * iternext ()
 PythonExtensionBase ()
void resetReferenceCount ()
virtual ~PythonExtensionBase ()
- Public Member Functions inherited from frepple::utils::HasDescription
string getCategory () const
string getDescription () const
string getSubCategory () const
void setCategory (const string &f)
void setDescription (const string &f)
void setSubCategory (const string &f)

Static Public Member Functions

static int initialize ()

Static Public Attributes

static const MetaCategorymetadata

Detailed Description

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

The 'available' calendar is used to model the working hours and holidays of resources, buffers and operations.

Definition at line 1119 of file model.h.


Constructor & Destructor Documentation

frepple::Location::Location ( const string &  n)
inlineexplicit

Constructor.

Definition at line 1123 of file model.h.

frepple::Location::~Location ( )
virtual

Destructor.

Definition at line 106 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::HasHierarchy< Location >.

Definition at line 73 of file location.cpp.

void frepple::Location::endElement ( XMLInput pIn,
const Attribute pAttr,
const DataElement pElement 
)

Reimplemented from frepple::utils::HasDescription.

Definition at line 82 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 1142 of file model.h.

PyObject * frepple::Location::getattro ( const Attribute attr)
virtual

Default getattro method.
Subclasses are expected to implement an override if the type supports gettattro.

Reimplemented from frepple::utils::PythonExtensionBase.

Definition at line 125 of file location.cpp.

CalendarDouble* 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 1132 of file model.h.

virtual const MetaClass& frepple::Location::getType ( ) const
inlinevirtual

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 1144 of file model.h.

int frepple::Location::initialize ( )
static

Reimplemented in frepple::LocationDefault.

Definition at line 32 of file location.cpp.

int frepple::Location::setattro ( const Attribute attr,
const PythonObject field 
)
virtual

Default setattro method.
Subclasses are expected to implement an override if the type supports settattro.

Reimplemented from frepple::utils::PythonExtensionBase.

Definition at line 147 of file location.cpp.

void frepple::Location::setAvailable ( CalendarDouble b)
inline

Updates the availability calendar of the location.

Definition at line 1135 of file model.h.

void frepple::Location::writeElement ( XMLOutput o,
const Keyword tag,
mode  m = DEFAULT 
) const

Reimplemented from frepple::utils::HasDescription.

Definition at line 53 of file location.cpp.


Member Data Documentation

const MetaCategory * frepple::Location::metadata
static

Reimplemented in frepple::LocationDefault.

Definition at line 1145 of file model.h.


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