frepple::OperationPlanAlternate Class Reference

This class subclasses the OperationPlan class for operations of type OperationAlternate. More...

#include <model.h>

Inheritance diagram for frepple::OperationPlanAlternate:

Public Member Functions
void	addSubOperationPlan (OperationPlan *o)
void	eraseSubOperationPlan (OperationPlan *o)
virtual OperationPlan *	getSubOperationPlan () const
bool	initialize ()
	OperationPlanAlternate ()
void	setEnd (Date d)
virtual void	setLocked (bool b=true)
void	setQuantity (double f, bool roundDown=false, bool update=true)
void	setStart (Date d)
void	update ()
	~OperationPlanAlternate ()
Friends
class	OperationAlternate

Detailed Description

This class subclasses the OperationPlan class for operations of type OperationAlternate.

Such operationplans need an extra field to point to the suboperationplan.

See also:: OperationPlan, OperationAlternate

Definition at line 2583 of file model.h.

Constructor & Destructor Documentation

frepple::OperationPlanAlternate::OperationPlanAlternate ( ) [inline]

Definition at line 2592 of file model.h.

frepple::OperationPlanAlternate::~OperationPlanAlternate ( )

Destructor.

Definition at line 898 of file operationplan.cpp.

Member Function Documentation

void frepple::OperationPlanAlternate::addSubOperationPlan ( OperationPlan * o )

Definition at line 879 of file operationplan.cpp.

void frepple::OperationPlanAlternate::eraseSubOperationPlan ( OperationPlan * o )

Definition at line 983 of file operationplan.cpp.

virtual OperationPlan* frepple::OperationPlanAlternate::getSubOperationPlan ( ) const [inline, virtual]

Returns the sub-operationplan.

Reimplemented from frepple::OperationPlan.

Definition at line 2604 of file model.h.

bool frepple::OperationPlanAlternate::initialize ( ) [virtual]

Initializes the operationplan. If no suboperationplan was created yet this method will create one, using the highest priority alternate.

Reimplemented from frepple::OperationPlan.

Definition at line 952 of file operationplan.cpp.

void frepple::OperationPlanAlternate::setEnd ( Date d ) [virtual]

Updates the end date of the operationplan. The start date is computed. Locked operationplans are not updated by this function.

Reimplemented from frepple::OperationPlan.

Definition at line 906 of file operationplan.cpp.

void frepple::OperationPlanAlternate::setLocked ( bool b = true ) [virtual]

Locks/unlocks an operationplan. A locked operationplan is never changed.

Reimplemented from frepple::OperationPlan.

Definition at line 928 of file operationplan.cpp.

void frepple::OperationPlanAlternate::setQuantity	(	double	f,
		bool	roundDown = `false`,
		bool	update = `true`
	)			`[virtual]`

Updates the quantity.
The operationplan quantity is subject to the following rules:

The quantity must be greater than the minimum size.
The value is rounded up to the minimum size ir required, or rounded down to 0.
The quantity must be a multiple of the multiple_size field.
The value is rounded up or down to meet this constraint.
There is no maximum size to an operationplan.
Setting the quantity of an operationplan to 0 is always possible, regardless of the minimum and multiples values. This method can only be called on top operationplans. Sub operation plans should pass on a call to the parent operationplan.

Reimplemented from frepple::OperationPlan.

Definition at line 969 of file operationplan.cpp.

void frepple::OperationPlanAlternate::setStart ( Date d ) [virtual]

Updates the start date of the operationplan. The end date is computed. Locked operation_plans are not updated by this function.

Reimplemented from frepple::OperationPlan.

Definition at line 917 of file operationplan.cpp.

void frepple::OperationPlanAlternate::update ( ) [virtual]

Updates the operationplan based on the latest information of quantity, date and locked flag.

Reimplemented from frepple::OperationPlan.

Definition at line 936 of file operationplan.cpp.