frepple Namespace Reference

Core namespace. More...


Classes

class  Association
 This template class represents a data structure for a load or flow network. More...
class  Attribute
 A class to model keyword instances. More...
class  AttributeList
 This class represents a dictionary of keyword + value pairs. More...
class  Buffer
 A buffer represents a combination of a item and location.
It is the entity for keeping modeling inventory. More...
class  BufferDefault
 This class is the default implementation of the abstract Buffer class. More...
class  BufferInfinite
 This class represents a material buffer with an infinite supply of extra material. More...
class  BufferProcure
 This class models a buffer that is replenish by an external supplier using a reorder-point policy. More...
class  Calendar
 This is the class used to represent variables that are varying over time. More...
class  CalendarBool
 A calendar storing boolean values in its buckets. More...
class  CalendarDouble
 A calendar storing double values in its buckets. More...
class  CalendarInt
 A calendar storing integer values in its buckets. More...
class  CalendarOperation
 A calendar storing pointers to operations in its buckets. More...
class  CalendarPointer
 This calendar type is used to store object pointers in its buckets. More...
class  CalendarString
 A calendar storing strings in its buckets. More...
class  CalendarValue
 This calendar type is used to store values in its buckets. More...
class  CalendarVoid
 A calendar only defining time buckets and not storing any data fields. More...
class  Command
 Abstract base class for all commands. More...
class  CommandCreateOperationPlan
 This command is used to create an operationplan. More...
class  CommandDeleteOperationPlan
 This command is used to delete an operationplan. More...
class  CommandErase
 This command deletes part of the model or the plan from memory. More...
class  CommandList
 A container command to group a series of commands together. More...
class  CommandLoadLibrary
 Command to dynamically load a shared library in frePPLe. More...
class  CommandMoveOperationPlan
 This class represents the command of moving an operationplan to a new date and/or resizing it. More...
class  CommandPlanSize
 This command prints a summary of the dynamically allocated memory to the standard output. This is useful for understanding better the size of your model. More...
class  CommandReadXMLFile
 This command is used for reading XML input. The input comes either from a flatfile, or from the standard input. More...
class  CommandReadXMLString
 This command is used for reading XML input from a certain string. More...
class  CommandSave
 This command writes the complete model to an XML-file. More...
class  CommandSavePlan
 This command writes the dynamic part of the plan to an text file. More...
class  CommandSetEnv
 Command to update an environment variable. More...
class  CommandSolve
 This command runs a specific solver. More...
class  CommandSystem
 This command executes a command line on your operating system. More...
class  Customer
 This abstracts class represents customers. More...
class  CustomerDefault
 This class implements the abstract Customer class. More...
class  DataElement
 This abstract class represents a attribute and value pair for updating objects in frePPLe. More...
class  DataException
 An exception of this type is thrown when data errors are found. More...
class  Date
 This class represents a date and time with an accuracy of one second. More...
class  DateRange
 This class defines a date-range, i.e. a start-date and end-date pair. More...
class  Demand
 Represents the (independent) demand in the system. It can represent a customer order or a forecast. More...
class  DemandDefault
 This class is the default implementation of the abstract Demand class. More...
class  Environment
 This class groups some functions used to interact with the operating system environment. More...
class  Flow
 This class defines a material flow to/from a buffer, linked with an operation. This default implementation plans the material flow at the start of the operation. More...
class  FlowEnd
 This class defines a material flow to/from a buffer, linked with an operation. This subclass represents a flow that is at end date of the operation. More...
class  FlowPlan
 A flowplan represents a planned material flow in or out of a buffer. More...
class  FlowStart
 This class defines a material flow to/from a buffer, linked with an operation. This subclass represents a flow that is at the start date of the operation. More...
class  Functor
 This abstract class is the base class used for callbacks. More...
class  FunctorInstance
 This class represents an object subscribing to a signal. More...
class  FunctorStatic
 This class represents a static subscription to a signal. More...
class  HasDescription
 This is a decorator class for the main objects. More...
class  HasHierarchy
 This is a base class for the main objects. More...
class  HasLevel
 The purpose of this class is to compute the levels of all buffers, operations and resources in the model, and to categorize them in clusters. More...
class  HasName
 Base class for objects using a string as their primary key. More...
class  HasProblems
 Classes that keep track of problem conditions need to implement this class. More...
struct  indent
class  Item
 An item defines the products being planned, sold, stored and/or manufactured. Buffers and demands have a reference an item. More...
class  ItemDefault
 This class is the default implementation of the abstract Item class. More...
class  Keyword
 This class defines a keyword for the frePPLe data model. More...
class  LibraryModel
 This class is used for initialization and finalization. More...
class  LibrarySolver
 This class holds functions that used for maintenance of the solver code. More...
class  LibraryUtils
 This class holds functions that used for maintenance of the library. More...
class  Load
 This class links a resource to a certain operation. More...
class  LoadPlan
 This class represents the resource capacity of an operationplan. More...
class  Location
 This abstract class is used to associate buffers and resources with a physical location. More...
class  LocationDefault
 This class implements the abstract Location class. More...
class  LogicException
 An exception of this type is thrown when the library gets in an inconsistent state from which the normal course of action can't continue. More...
class  MetaCategory
 A MetaCategory instance represents metadata for a category of object. More...
class  MetaClass
 This class stores metadata about the classes in the library. The stored information goes well beyond the standard 'type_info'. More...
class  Mutex
 This class is a wrapper around platform specific mutex functions. More...
class  NonCopyable
 Class NonCopyable is a base class.
Derive your own class from it when you want to prohibit copy construction and copy assignment. More...
class  Object
 Object is the abstract base class for the main entities. More...
class  Operation
 An operation represents an activity: these consume and produce material, take time and also require capacity. More...
class  OperationAlternate
 This class represents a choice between multiple operations. The alternates are sorted in order of priority. More...
class  OperationFixedTime
 Models an operation that takes a fixed amount of time, independent of the quantity. More...
class  OperationPlan
 An operationplan is the key dynamic element of a plan. It represents a certain quantity being planned along a certain operation during a certain date range. More...
class  OperationPlanAlternate
 This class subclasses the OperationPlan class for operations of type OperationAlternate. More...
class  OperationPlanRouting
 OperationPlans for routing operation uses this subclass for the instances. More...
class  OperationRouting
 Represents a routing operation, i.e. an operation consisting of multiple, sequential sub-operations. More...
class  OperationTimePer
 Models an operation whose duration is the sum of a constant time, plus a cetain time per unit. More...
class  PeggingIterator
 This class allows upstream and downstream navigation through the plan. More...
class  Plan
 This is the (logical) top class of the complete model. More...
class  Plannable
 This class needs to be implemented by all classes that implement dynamic behavior in the plan. More...
class  Problem
 A problem represents infeasibilities, alerts and warnings in the plan. More...
class  ProblemBeforeCurrent
 A problem of this class is created when an operationplan is being planned in the past, i.e. it starts before the "current" date of the plan. More...
class  ProblemBeforeFence
 A problem of this class is created when an operationplan is being planned before its fence date, i.e. it starts 1) before the "current" date of the plan plus the release fence of the operation and 2) after the current date of the plan. More...
class  ProblemCapacityOverload
 A problem of this class is created when a resource is being overloaded during a certain period of time. More...
class  ProblemCapacityUnderload
 A problem of this class is created when a resource is loaded below its minimum during a certain period of time. More...
class  ProblemDemandNotPlanned
 A Problem of this class is created in the model when a new demand is brought in the system, but it hasn't been planned yet. More...
class  ProblemEarly
 A problem of this class is created when a demand is planned earlier than the accepted tolerance before its due date. More...
class  ProblemExcess
 A problem of this class is created when a demand is planned for more than the requested quantity. More...
class  ProblemLate
 A problem of this class is created when a demand is satisfied later than the accepted tolerance after its due date. More...
class  ProblemMaterialExcess
 A problem of this class is created when a buffer is carrying too much material during a certain period of time. More...
class  ProblemMaterialShortage
 A problem of this class is created when a buffer is having a material shortage during a certain period of time. More...
class  ProblemPlannedEarly
 A problem of this class is created when a demand is planned earlier than the accepted tolerance before its epst date. More...
class  ProblemPlannedLate
 A problem of this class is created when an OperationPlan is planned later than the accepted tolerance after its lpst Date. More...
class  ProblemPrecedence
 A problem of this class is created when the sequence of two operationplans in a routing isn't respected. More...
class  ProblemShort
 A problem of this class is created when a demand is planned for less than the requested quantity. More...
class  Resource
 This class represents a workcentre, a physical or logical representation of capacity. More...
class  ResourceDefault
 This class is the default implementation of the abstract Resource class. More...
class  ResourceInfinite
 This class represents a resource that'll never have any capacity shortage. More...
class  RuntimeException
 An exception of this type is thrown when the library runs into problems that are specific at runtime.
These could either be memory problems, threading problems, file system problems, etc... More...
class  ScopeMutexLock
 This is a convenience class that makes it easy (and exception-safe) to lock a mutex in a scope. More...
class  Solvable
 This class needs to be implemented by all classes that implement dynamic behavior, and which can be called by a solver. More...
class  Solver
 This class is an implementation of the "visitor" design pattern. It is intended as a basis for different algoritms processing the frePPLe data. More...
class  SolverMRP
 This solver implements a heuristic algorithm for planning demands. More...
class  TimeLine
 This class implements a "sorted list" data structure, sorting "events" based on a date. More...
class  TimePeriod
 This class represents a time duration with an accuracy of one second. More...
class  Timer
 This class is used to measure the processor time used by the program. More...
class  Tree
 This class implements a binary tree data structure. It is used as a container for entities keyed by their name. More...
class  XMLAttributeList
 This class represents a list of XML attributes. More...
class  XMLElement
 This class represents an XML element being read in from the input file. More...
class  XMLInput
 This class will read in an XML-file and call the appropriate handler functions of the Object classes and objects. More...
class  XMLInputFile
 This class reads XML data from a file system. More...
class  XMLInputString
 This class reads XML data from a string. More...
class  XMLinstruction
 This abstract class is the used for defining classes that are used to implement processing functionality linked to XML processing instructions. More...
class  XMLOutput
 Base class for writing XML formatted data to an output stream. More...
class  XMLOutputFile
 This class writes XML data to a flat file. More...
class  XMLOutputString
 This class writes XML data to a string. More...

Typedefs

typedef unsigned int hashtype

Enumerations

enum  Action { ADD = 0, CHANGE = 1, REMOVE = 2, ADD_CHANGE = 3 }
enum  mode { DEFAULT = 0, REFERENCE = 1, NOHEADER = 2, FULL = 3 }
enum  Signal { SIG_ADD = 0, SIG_REMOVE = 1 }

Functions

ostream logger (cout.rdbuf())
ostream & operator<< (ostream &os, const DateRange &dr)
ostream & operator<< (ostream &os, const Date &d)
ostream & operator<< (ostream &os, const TimePeriod &t)
ostream & operator<< (ostream &os, const Timer &t)
ostream & operator<< (ostream &os, const indent &i)
ostream & operator<< (ostream &os, const Signal &d)
ostream & operator<< (ostream &os, const Action &d)
double suggestQuantity (const BufferProcure *b, double f)

Variables

ostream logger

Detailed Description

Core namespace.

Typedef Documentation

typedef unsigned int frepple::hashtype

This is the datatype used for hashing an XML-element to a numeric value.

Definition at line 234 of file utils.h.

Enumeration Type Documentation

enum frepple::Action

This type defines what operation we want to do with the entity.

Enumerator:
ADD  or A.
Add an new entity, and report an error if the entity already exists.
CHANGE  or C.
Change an existing entity, and report an error if the entity doesn't exist yet.
REMOVE  or D.
Delete an entity, and report an error if the entity doesn't exist.
ADD_CHANGE  or AC.
Change an entity or create a new one if it doesn't exist yet.
This is the default action.

Definition at line 177 of file utils.h.

enum frepple::mode

This type is used to define different ways of persisting an object.

Enumerator:
DEFAULT  Write the full object or a reference. If the object is nested more than one level deep a reference is written, otherwise the complete object is written.
This mode is the one to be used when dumping all objects to be restored later. The other modes can dump too little or too much data. Eg: <MODEL NAME="POL" TYPE="a"><FIELD>value</FIELD></MODEL>
REFERENCE  Write only the key fields of the object.
Eg: <MODEL NAME="POL" TYPE="a"/>
NOHEADER  Write the full object, but without a header line. This method is typically used when a subclass calls the write method of its parent class.
Eg: <FIELD>value</FIELD></MODEL>
FULL  Write the full object, with all its fields and a header line.
Eg: <MODEL NAME="POL" TYPE="a"><FIELD>value</FIELD></MODEL>

Definition at line 1507 of file utils.h.

enum frepple::Signal

This type defines the types of callback events possible.

Enumerator:
SIG_ADD  Adding a new entity.
SIG_REMOVE  Deleting an entity.

Definition at line 212 of file utils.h.

Function Documentation

ostream frepple::logger ( cout.  rdbuf()  ) 

ostream& frepple::operator<< ( ostream &  os,
const DateRange &  dr 
) [inline]

Prints a date range to the outputstream.

See also:
DateRange::string()

Definition at line 1495 of file utils.h.

ostream& frepple::operator<< ( ostream &  os,
const Date &  d 
) [inline]

Prints a date to the outputstream.

Definition at line 1372 of file utils.h.

ostream& frepple::operator<< ( ostream &  os,
const TimePeriod &  t 
) [inline]

Prints a Timeperiod to the outputstream.

See also:
TimePeriod::string()

Definition at line 1185 of file utils.h.

ostream& frepple::operator<< ( ostream &  os,
const Timer &  t 
) [inline]

Prints a timer to the outputstream. The output is formatted as a double.

Definition at line 1063 of file utils.h.

ostream& frepple::operator<< ( ostream &  os,
const indent &  i 
) [inline]

Print a number of spaces to the output stream.

Definition at line 248 of file utils.h.

ostream& frepple::operator<< ( ostream &  os,
const Signal &  d 
) [inline]

Writes a signal description to an output stream.

Definition at line 222 of file utils.h.

ostream& frepple::operator<< ( ostream &  os,
const Action &  d 
) [inline]

Writes an action description to an output stream.

Definition at line 198 of file utils.h.

double frepple::suggestQuantity ( const BufferProcure *  b,
double  f 
)

Definition at line 34 of file solverprocure.cpp.

Variable Documentation

ostream frepple::logger

This stream is the general output for all logging and debugging messages.

Documentation generated by  doxygen