Tools

Description

A class for creating and getting Tool nodes.

Tool Types

The Tools methods take only the following tool types:

  • AgentSystem
  • CalculatedTable
  • ColorPalette
  • DatabaseConnector
  • DownBehavior
  • EmpiricalDistribution
  • FlowItem
  • GlobalTable
  • GlobalVariable
  • Group
  • List
  • MilestoneCollector
  • ModelBackground
  • ModelTrigger
  • MTBFMTTR
  • ParameterTable
  • PerformanceMeasureTable
  • PropertyTable
  • ReinforcementLearning
  • StateTable
  • StatisticsCollector
  • TimeTable
  • UserEvent
  • TrackedVariable

Tool Sub Types

Some tool types have sub types that can be used in the create() method to make a preconfigured version of that tool. Only the ModelTrigger tools require a sub type to be specified. For the other tools, not specifying a sub type will make a basic version of that tool with out any preconfiguration.

  • AgentSystem
    • Proximity
    • SocialForce
  • ColorPalette
    • Standard
    • ByNumber
    • Viridis
    • Plasma
    • Rainbow
  • FlowItem
    • Container
    • TaskExecuter
    • Man
    • Woman
    • Boy
    • Girl
    • EmptyBottle
    • EmptyBottleWithLabel
    • FullBottle
    • FullBottleWithLabel
    • FullBottleWithCap
    • FullBottleWithLabelAndCap
    • AllBottles
  • List
    • FixedResource
    • Item
    • TaskExecuter
    • TaskSequence
  • ModelTrigger
    • OnModelOpen
    • OnModelReset
    • OnRunStart
    • OnRunStop
  • StateTable
    • Default
    • PhotoEye

Static Methods

create Creates a new copy of a tool node.
get Gets a reference to an exisiting tool node.

Details

Do no remove, this fixes the anchor on doc.flexsim.com

Tools.create()

static treenode create( string type , string subType = '' )

Parameters

type The name of the type of tool to create. See Tool Types for the full list.
subType The name of the sub type of tool to create. See Sub Tool Types for the full list.

Returns

treenode A new tool node.

Description

Creates a new copy of a tool node.


treenode basicList = Tools.create("List");
treenode teList = Tools.create("List", "TaskExecuter");
			
Do no remove, this fixes the anchor on doc.flexsim.com

Tools.get()

static treenode get( string type , string name )

Parameters

type The name of the type of tool to get. See Tool Types for the full list.
name The name of the tool to get.

Returns

treenode A reference to an existing tool node.

Description

Gets a reference to an exisiting tool node.

treenode timeTable = Tools.get("TimeTable", "Shift1");