Main > Reference Manual > Modeling > Load
Loads are used to model the capacity consumption of an operation.
Fields
Field | Type | Description |
resource | resource |
Resource being loaded. |
operation | operation |
Operation loading the resource. |
quantity | double |
Load factor of the resource. |
effective_start | dateTime |
Date after which the resource load is valid. |
effective_end | dateTime |
Date at which the resource load becomes invalid. |
priority | integer |
Priority of the load, used in case of alternate load. |
name | non-empty string |
Optional name of the load. |
alternate | non-empty string or load | Name of the load of which this is an alternate. When using the Python API the argument can be a load or a string. When using the XML data format the argument is a string. |
setup | non-empty string | Name of the required setup on the resource. |
search | string |
Defines the order of preference among the alternate loads.
|
action | A C AC (default) R |
Type of action to be executed:
|
Example XML structures
- Defining a load
<plan> <loads> <load> <resource name="machine A"/> <operation name="operation B"/> </load> </loads> </plan>
- Defining a load nested in an operation structure.
Resources A AND B are used by the operation.
<plan> <operations> <operation name="operation B"> <loads> <load> <resource name="machine A"/> <usage>1</usage> </load> <load> <resource name="machine B"/> <usage>1</usage> </load> </loads> </operation> </operations> </plan>
- Defining a load nested in an operation structure.
Resource A OR B is used by the operation.
<plan> <operations> <operation name="operation B"> <loads> <load> <resource name="machine A"/> <usage>1</usage> <priority>0</priority> <name>alt</name> </load> <load> <resource name="machine B"/> <usage>1</usage> <priority>1</priority> <alternate>alt</alternate> </load> </loads> </operation> </operations> </plan>
- Defining a load nested in a resource structure
<plan> <resources> <resource name="machine A"> <loads> <load> <operation name="operation B"/> <usage>2</usage> </load> <load> <operation name="operation C"/> <usage>1</usage> </load> </loads> </resource> </resources> </plan>
- Deleting a load
<plan> <loads> <load action="R"> <resource name="machine A"/> <operation name="operation B"/> </load> </loads> </plan>