frepple::OperationPlanAlternate Class Reference
This class subclasses the OperationPlan class for operations of type OperationAlternate. More...
#include <model.h>
Public Member Functions | |
| void | addSubOperationPlan (OperationPlan *o) |
| void | eraseSubOperationPlan (OperationPlan *o) |
| virtual OperationPlan * | getSubOperationPlan () const |
| bool | initialize () |
| OperationPlanAlternate () | |
| void | setEnd (Date d) |
| 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 2500 of file model.h.
Constructor & Destructor Documentation
| frepple::OperationPlanAlternate::OperationPlanAlternate | ( | ) | [inline] |
| frepple::OperationPlanAlternate::~OperationPlanAlternate | ( | ) |
Destructor.
Definition at line 872 of file operationplan.cpp.
Member Function Documentation
| void frepple::OperationPlanAlternate::addSubOperationPlan | ( | OperationPlan * | o | ) | [virtual] |
Add a sub-operationplan to the list. For normal operationplans this is only a dummy function. For alternates and routing operationplans it does have a meaning.
Reimplemented from frepple::OperationPlan.
Definition at line 853 of file operationplan.cpp.
| void frepple::OperationPlanAlternate::eraseSubOperationPlan | ( | OperationPlan * | o | ) | [virtual] |
Remove a sub-operation_plan from the list. For normal operation_plans this is only a dummy function. For alternates and routing operationplans it does have a meaning.
Reimplemented from frepple::OperationPlan.
Definition at line 944 of file operationplan.cpp.
| virtual OperationPlan* frepple::OperationPlanAlternate::getSubOperationPlan | ( | ) | const [inline, virtual] |
Returns the sub-operationplan.
Reimplemented from frepple::OperationPlan.
| 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 913 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 880 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 930 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 891 of file operationplan.cpp.
| void frepple::OperationPlanAlternate::update | ( | ) | [virtual] |
Friends And Related Function Documentation
friend class OperationAlternate [friend] |
The documentation for this class was generated from the following files:
Documentation generated by
