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.
This is a required field.

operation operation

Operation loading the resource.
This is a required field.

quantity double

Load factor of the resource.
The default value is 1.0.

effective_start dateTime

Date after which the resource load is valid.
Before this date the planned quantity is always 0.

effective_end dateTime

Date at which the resource load becomes invalid.
After this date (and also at the exact date) the planned quantity is always 0.

priority integer

Priority of the load, used in case of alternate load.
The default is 1. Lower numbers indicate more preferred loads.

name non-empty string

Optional name of the load.
A name is only useful when using alternate loads. Otherwise leave it empty to save some memory.

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.
The valid choices are:

  • PRIORITY
    Select the alternate with the lowest priority number.
    This is the default.
  • MINCOST
    Select the alternate which gives the lowest cost.
    The cost includes the cost of all upstream operations, resources and buffers.
  • MINPENALTY
    Select the alternate which gives the lowest penalty.
    The penalty includes the penalty of all penalties incurred in the upstream plan along the flow.
  • MINCOSTPENALTY
    Select the alternate which gives the lowest sum of the cost and penalty.
    The sum is computed for the complete upstream path.
action A
C
AC (default)
R

Type of action to be executed:

  • A: Add an new entity, and report an error if the entity already exists.
  • C: Change an existing entity, and report an error if the entity doesn't exist yet.
  • AC: Change an entity or create a new one if it doesn't exist yet.
  • R: Remove an entity, and report an error if the entity doesn't exist.

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>