User Commands

Deprecated. This command has been deprecated. Instead, you should use flowObject.product = newProduct;

Changes the speed of a task executer travelling an network edge.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.ports.close(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports.close(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.close(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.ports[portNumber].open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports[portNumber].close(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.close(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.connect( model.find( "OtherFlowObject" ) );

Deprecated. This command has been deprecated. Instead, you should use flowObject.flowControl = model.find("FlowControl1");

Disconnects a flow object from its control and all incoming and outgoing objects.

Deprecated. This command has been deprecated. Instead, you should use flowObject.flowControl = nullvar;

Ends an impact factor event, which temporarily decreased or increased the maximum flow of a FloWorks object. The impact factor event applies a multiplicative factor to the maximum flow rate, which can completely stop or reduce the flow because of a failure mode; but by setting a factor larger than 1 this function can also be used to model increased productivity due to e.g. seasonal fluctuations. This function is called automatically from the "up" trigger of a FloWorks Impact Event, you usually only need to call it manually if you explicitly used the StartImpactFactorEvent command. Note that multiple events may be active on a flow object at any time, and multiple flow objects may be impacted by an event, so you may need to call this command more than once.

For developer use only.

Calculates the earliest possible start time for a sequence on a workability object, at or after the current time plus the given offset (defaults to 0). The workability object can be specified by name, or by a direct reference. The sequence can be specified by name or by index (starting at 1). If the workability could not be determined, the function returns -1.

Deprecated. This command has been deprecated. Instead, you should use double content = flowTank.content;

Deprecated. This command has been deprecated. Instead, you should use Object flowControl = flowObject.flowControl;

Deprecated. This command has been deprecated. Instead, you should use double inputAmount = flowObject.input.amount;

Deprecated. This command has been deprecated. Instead, you should use double inputRate = flowObject.input.rate;

Deprecated. This command has been deprecated. Instead, you should use double inputTriggerAmount = flowObject.input.triggerAmount;

Deprecated. This command has been deprecated. Instead, you should use double maxContent = flowTank.maxContent;

Returns the current FloWorks license.

Deprecated. This command has been deprecated. Instead, you should use double outputAmount = flowObject.output.amount;

Deprecated. This command has been deprecated. Instead, you should use double outputRate = flowObject.output.rate;

Deprecated. This command has been deprecated. Instead, you should use double outputTriggerAmount = flowObject.output.triggerAmount;

Finds the numeric ID of a product by name.

Deprecated. This command has been deprecated. Instead, you should use flowObject.product;

Deprecated. This command has been deprecated. Instead, you should use flowObject.stats.utilization;

Calculates the level value of the level triggered event. If atTime is passed, the level at the given time is returned, otherwise the current value is calculated. The event object can be specified by name, or by a direct reference. If the level cannot be determined, for example because you are reading past the end of a non-repeating table, the flag value -999999 is returned.

Returns the precision for displaying floating point numbers, according to FlexSim settings. It is mostly useful for converting numbers to text using the numtostring command.

Loads a recipe for a specific product from the Products Table into the Flow Mixer recipe table. The mixer's Product Source trigger is used to decide which ports will be pulled from.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports.open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports.open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.ports[portNumber].open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports[portNumber].open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.open(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.ports[portNumber].select(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports[portNumber].select(); Note that some objects, such as the Flow Mixer, may use commands like this to manage their flow, it is safer to use flowObject.output.close(); than flowObject.output.ports.close();.

Sets the arrow style variable for the given FloWorks object, and removes or adds the arrows, depending on the given style. The following arrow styles are supported: 1: IN connections, using preferably a single arrow from OUT to IN. 2: IN connections, using preferably a short arrow only connected to IN. 3: OUT connections, using preferably a single arrow from OUT to IN. 4: Both (1) and (3) 5: Both (2) and (3) 6: OUT connections, using preferably a short arrow only connected to OUT. 7: Both (1) and (6) 8: Both (2) and (6)

Deprecated. This command has been deprecated. Instead, you should use flowTank.content = newContent;

Sets the speed of the flow conveyor. Setting the speed to 0 will stop the conveyor and close inputs and outputs. Setting the speed to a negative value will reverse the direction of the conveyor.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.triggerAmount = newTriggerAmount;

Deprecated. This command has been deprecated. Instead, you should use flowTank.maxContent = newMaximumContent;

Set the number of trigger levels of a content-holding flow object such as a tank. After setting the number of trigger levels, you can use the SetFlowTriggerLevel command to set the level at which these triggers fire. Only use this to initialise the object. Do not use during runtime.

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.triggerAmount = newTriggerAmount;

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.maxRate = value; or flowObject.output.maxRate = value;

Set the trigger level of a content-holding flow object such as a tank. Only use this to initialise the object. Do not use during runtime.

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.ports[portNumber].ratio = newValue;

Deprecated. This command has been deprecated. Instead, you should use flowObject.input.maxRate = value; or flowObject.output.maxRate = value;

Deprecated. This command has been deprecated. Instead, you should use flowObject.output.ports[portNumber].ratio = newValue;

Deprecated. This command has been deprecated, do not use it.

Start the next recipe on a flow mixer in non-repeating mode. Returns 0 if the recipe has started successfully.

Start an impact factor event, which temporarily decreases or increases the maximum flow of a FloWorks object. The impact factor event applies a multiplicative factor to the maximum flow rate, which can completely stop or reduce the flow because of a failure mode; but by setting a factor larger than 1 this function can also be used to model increased productivity due to e.g. seasonal fluctuations. This function is called automatically from the "down" trigger of a FloWorks Impact Event, you do not usually need to call it manually.

Stops loading of the specified transporter at the given loading point. This function can only be called if loading duration is set manually (loading time function returned 0). Otherwise loading will stop automatically after the given time.