Home

JaamSim Manual (full)

1. Keyword Description AttributeDefinitionList NextComponentList Choice Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity A list of possible objects to which an incoming entity can be passed A number that determines which downstream branch will be chosen for the incoming entity 1 first branch 2 second branch etc O Ausenc 2014 36 September 8 2014 JaamSim User Manual Outputs Output Name Description obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time 10 15 Duplicate The Duplicate object sends copies of the received entity to one or more objects Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity NextComponent The next object to which a received entity is passed TargetComponentList The list of objects to which a copy of the received entity will be sent Outputs Output Name Description obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time 10 16
2. Gen Position 2 234651 3 249747 0 000000 m Gen Size 1 000 1 000 0 0 m Gen NextComponent GenToServ Gen InterArrivalTime ExponentialDistributionl T Gen PrototypeEntity Proto 2014 36 68 A G September 8 2014 usencs JaamSim User Manual GenToServ Position 1 149286 3 249747 0 000000 m GenToServ Size 1 000 1 000 0 0 m GenToServ NextComponent Serv GenToServ TravelTime 1 s GenToServ Points 1 149 3 250 0 000 m 0 149 3 250 0 000 m Serv Position 0 507324 3 321153 0 000000 m Serv Size 1 000 1 000 0 0 m Serv NextComponent ServToSink Serv ServiceTime 1 0 s Serv WaitQueue ServQueue ServToSink Position 1 321349 3 349715 0 000000 m ServToSink Size 1 000 1 000 0 0 m ServToSink NextComponent Sink ServToSink TravelTime 1 5 s ServToSink Points L 1 322 3 349 0 000 m 2 322 3 349 0 000 m Sink Position 2 949394 3 321153 0 000000 m Sink Size 1 000 1 000 0 0 m ServQueue Position 0 450198 4 492204 0 000000 m ServQueue Size 0 5 0 5 m ExponentialDistributionl Position 1 492032 0 493496 0 000000 m ExponentialDistributionl Size 1 000 1 000 0 0 m ExponentialDistributionl UnitType TimeUnit ExponentialDistributionl MinValue 0 s ExponentialDistributionl MaxValue 10 s ExponentialDistributionl Mean 2 s 2014 36 69 A September 8 2014 Au senco
3. ColladaFile A list of animation Actions and the object Outputs to which they are to be connected in the format Action1 Output1 Action2 Output2 In this Actions example the actions Action1 and Action2 must be available for the graphical asset specified by the ColladaFile input The outputs Output1 and Output2 must be valid outputs for the entity to which this ColladaModel is assigned Animation is only available for 3D objects in the JSM format The following outputs are provided for ColladaModels Outputs Output Name Description Actions A list of the actions that are provided in the JSM file Vertices The number of unique vertices that are specified in the 3D model Triangles The number of unique triangles that are specified in the 3D model The ratio number of triangles number of vertices 3 Equal to 1 0 if every vertex VertexShareRatio S is used in only one triangle 8 2 ImageModel ImageModel objects are used to display custom 2D graphics in a simulation model such as a picture or a map Both DisplayEntity and Overlaylmage can accept an ImageModel object as an input Image file types currently supported by JaamSim include BMP GIF JPG PCX and PNG files or a ZIP file containing any one of these file types The table below describes the additional inputs for ImageModel objects Key Inputs Keyword Description A file path to the image file to be used for this display model Must be enclosed in
4. 4 c a Z x E A a 9 Labels Ticks aa z L c 0 h XAxisLabelGap gt 24h 16h 8h Now BottomMargin 8h 5 O d Ausenc September 8 2014 Keyword Title NumberOfPoints DataSource LineColours LineWidths SecondaryDataSource SecondaryLineColours SecondaryLineWidths Keyword XAxis Title XAxisUnit XAxisStart XAxisEnd XAxisInterval XAxisLabelFormat Lines XLinescolour Keyword YAxisTitle YAxisUnit YAxisStart YAxisEnd YAxisInterval YAxisLabelFormat YLines YLinescolour JaamSim User Manual Key Inputs Description Text for the graph title enclosed in single quotes if it contains spaces The number of data points to be displayed on the graph This determines the resolution of the graph One or more sources of data to be graphed against the primary y axis A list of colours for the data series to be displayed For multiple colours each colour must be enclosed in braces as each colour can be itself defined as a list of RGB values A list of widths in pixels for the data series to be displayed One or more sources of data to be graphed against the secondary y axis A list of colours for the data series to be displayed For multiple colours each colour must be enclosed in braces as each colour can be itself defined as a list of RGB values A list of widths in pixels for the data series to be displayed X Axis Keywords Description Title text for the x axis T
5. Assemble The Assemble object combines a number of sub components into an assembled part Sub components waiting for processing are collected into a series of Queue objects identified by the WaitQueueList keyword one for each type of sub component Incoming sub components are directed to a queue using the Choice keyword Normally this keyword would refer to an Attribute of the incoming entity For example if the incoming entity has an attribute named Type whose value was 1 for the first type sub component 2 for the second type of sub component etc then the entry for the Choice keyword should be the expression this obj Type The assembly process begins when there is at least one sub component entity in each of the queues When this occurs the first sub component in each queue is removed and destroyed and a new assembled part is created by copying the object specified by the PrototypeEntity keyword The time required to complete the assembly process is given by the ServiceTime keyword Default Graphic O Ausenc 2014 36 September 8 2014 E Keyword Description AttributeDefinitionList NextComponent Operating ThresholdList SeniceTime WaitQueueList Choice PrototypeEntity Output Name obj NumberAdded NumberProcessed ProcessingRate 10 17 EntityGate JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to th
6. Examples of the conditional operator are cel Es 24 this OutputA gt 2 Entityl OutputB 1 0 There is no limit to the length or complexity of an expression Conditional operators can be mixed freely with any other mathematical operations in an expression Attributes In addition to the pre programmed outputs users can create custom outputs called attributes for individual objects Attributes appear in the Output Viewer immediately after being defined through the AttributeDefinitionList keyword and as such can be referenced through the ObjectName OutputName format except replacing the OutputName with the desired attribute name Attributes are added using the AttributeDefinitionList keyword in the Key Inputs tab for an entity using the format AttributeName 1 InitialValue1 Unit1 AttributeNameN Initial ValueN UnitN For example the inputs to create two new attributes AttributeA and AttributeB with initial values of 1 km and 9 dimensionless are AttributeA 1 km AttributeB 9 Attributes are used in expressions in the same way as an outputs For instance if the above AttributeA was defined for Entity1 then it is referenced by Entity1 AttributeA Once an attribute has been defined only the Assign object can modify its value 11 2 Editing the Configuration File JaamSim has been designed such that simple simulation models can be realized using the Graphical User Interface alone This
7. List of objects SimEntity ReportGenerator EntityLogger EntityGenerator Server EntitySink EntityConveyor EntityDelay Assign Queue Seize Release Resource Branch Duplicate Assemble EntityGate EntitySignal EntityContainer Pack Unpack TimeSeries SignalThreshold ExpressionThreshold TimeSeriesThreshold Statistics eoeeseeeeesgsees5 5 eseseees s 8oe e8e08088fe8e0e e8e 8 ee 8 10 1 SimEntity The SimEntity object is the basic entity that is passed through a process flow type model The main feature of SimEntity is its output named State that indicates what activity the SimEntity is performing at the present time Its state can be set whenever it enters a new object using the StateAssignment keyword for that object The user is free to choose the appropriate state names to use Note however that state names cannot include any blanks or special characters A SimEntity tracks the time its spends in each state during the simulation run This information can be reported using the EntityLogger and ReportGenerator objects Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity O 2014 36 40 A A September 8 2014 usenc 2014 36 September 8 2014 JaamSim User Manual Outputs Output Name Description State The present user defined activity being performed by the SimEntity 10
8. Resizing an Object 2 Use these methods to move and resize components as necessary Since the XYZ Axis marker isn t beneficial to this model deleting it will make the model less cluttered To do this select the XYZ Axis by going into Object Selector and expanding the Graphics Objects palette then the DisplayEntity palette Right click the XYZ Axis and choose Delete Deleting Objects RE Defined Objects ns E Simulation Controls Y L Units Display Models Graphics Objects p View Viewi 2 DisplayEntity XY Grid Input Editor Output Viewer i Overlaylmag Property Viewer E OverlayText Duplicate gece Ones BEE Basic Objects ka i Change Graphics Add Label Center in View Lastly change the Model Title in the View Window by returning to Object Selector and expanding the OverlayText palette Select the Title object and enter the following keyword under the Key Inputs tab in the Input Editor 6 C 2014 36 10 A a September 8 2014 usencc 2014 36 September 8 2014 JaamSim User Manual Changing the Model Title Object Keyword Value Title Format Getting Started with JaamSim Changing the Model Title BEE Defined Objects Simulation Controls Units Display Models Graphics Objects ad View viewi 2014 Jan Ol 00 00 00 000 DisplayEntity Overlaylmage OverlayText WG B OverlayClo
9. 2 ReportGenerator The ReportGenerator object controls the initialization period and duration of the simulation run and prints the output report A simulation run is executed in two steps The first step is the initialization period which should be long enough for the model to reach typical inventory levels for the various storage objects and typical lengths for the various queues The statistics collected by each object are cleared at the end of the initialization period The second step is the run duration over which the final set of statistics is collected An output report is created at the completion of the run and the simulation is either paused or if in batch mode terminated The InitializationDuration and RunDuration keywords determine the initialization period and the duration of the simulation run respectively Note that total length of the simulation run is equal to the sum of these values No more than one ReportGenerator can be defined for a simulation model The output report is a text file whose file name is the same as the configuration file name with the extension changed to rep The output report is created in the same directory as the configuration file unless another directory is specified using the ReportDirectory keyword The output file consists of a listing of the output values that appear in the Output Viewer Only the outputs for statistical values or attributes values are printed To avoid unnecessary clutter outputs
10. 2014 uUsenNecs 2014 36 September 8 2014 JaamSim User Manual 2 Installing JaamSim 2 1 System Requirements JaamSim runs under Windows Linux and OSX on most modern computers Support is required for OpenGL graphics version 3 0 or later OpenGL 2 1 is also supported with some degraded functionality These specifications are provided by typical laptop computers with Intel Core i5 and i7 series processors with integrated graphics second generation processors and later The following system specifications are recommended for optimal performance e Intel Core i7 processor e 16 GB of RAM e NVIDIA Quadro 600 video card or better For models with high end graphics we recommend the NVIDIA GeForce 780 graphics card or better It is not necessary to use the more expensive workstation type graphics cards Although it is possible to use a computer with an AMD graphics card we find that NVIDIA cards provide better support for OpenGL graphics and are preferred for JaamSim 2 2 Installing Java JaamSim requires a recent Version 7 or later installation of the Java Runtime Environment JRE available for download free of charge from www oracle com The 64 bit version of the JRE is preferred for 64 bit operating systems 2 3 Installing JaamSim JaamSim consists of a single executable that can be copied directly to the user s computer No special installation program is required Copy the JaamSim executable file to a working direc
11. 255 gray68 173 173 173 cyan oo 255 255 gray67 171 171 171 turquoise 4224 208 gray66 oe 168 168 168 mediumturquoise 72 209 204 gray65 L 16 166 166 lightseagreen ee 22 178 170 gray64 L 163 163 163 manganeseblue 168 158 gray63 ste 161161 teal 128 128 gray62 158 158 darkslategray 47 79 79 gray61 BE 156 156 156 turquoiseblue Dy o 199 140 gray60 Bee 153 153 153 aquamarine ee 127 255 212 gray59 Bee 150 150 150 mintcream 245 255 250 gray58 jaa 148 148 148 mint 189 252 201 gray57 Dy 45 145 145 seagreen ee 255 159 gray56 Dy 149 13 148 mediumspringgreen FF o 280 154 gray55 BE 10 140 10 springgreen 255 127 gray54 ae 138 138 138 emeraldgreen 201 87 gray53 Be 135 15 135 mediumseagreen SE 60 179 113 gray52 Be 133 133 133 cobaltgreen CIE gray51 E 190 130 130 darkseagreen a 188 143 gray50 ee 197 17 17 honeydew 240 255 240 gray49 E 128 15 125 palegreen 152 251 152 gray48 BE gt 12 12 lawngreen ee 124 22 0 gray47 Dy 120 1m 12 greenyellow fe 173 255 47 gray46 7 117 907 limegreen L 50 205 50 gray45 Bi 115 115 115 forestgreen RS 34 130 34 gray44 E 119 2 12 sapgreen E s i 20 gray43 E 110 110 Mo green ie 128 0 gray42 S 107 107 107 darkgreen Be 10 0 gray41 S 109 105 105 D C 2014 36 66 A A September 8 2014 usencg 2014 36 September 8 2014 Colour Name darkolivegreen olivedrab olive ivory lightyellow lightgoldenrodyellow comsilk lemonchiffon beige
12. For example the Text object a subclass of DisplayEntity and the TextModel a subclass of DisplayModel work together to display text The text to be displayed is determined by the Text object while the style of the displayed text font bold italics colour etc is determined by the TextModel object In this case the TextModel plays the same role as a text style in word processing software The analyst can ensure that the same text style is used for multiple Text objects by sharing the same TextModel between all these objects Although DisplayModels determine the appearance of a DisplayEntity the DisplayModel has no graphics itself and therefore cannot be dragged and dropped in the normal manner To create a new DisplayModel simply duplicate an existing DisplayModel JaamSim starts with a pre defined example of each type of Display Model that can be used for this purpose Duplicate an example Display Model by right clicking its entry in the Object Selector and selecting Duplicate then edit its attributes and name as necessary A selection of DisplayModels can be found in the Display Models palette in the Object Selector Each of these subclasses of DisplayModel in intended for a particular subclass of DisplayEntity as noted below List of objects s ColladaModel s ImageModel e TextModel e ScreenPointsModel e ArrowModel e GraphModel e DisplayModelCompat All of these various Display Model objects have the same Basic Graphics k
13. ImageFile single quotes if the path contains spaces Transparent If TRUE transparency is enabled for supported image types GIF and PNG CompressedTexture If TRUE image compression is applied in order to alleviate memory issues with large images O i Ausenc JaamSim User Manual 8 3 TextModel TextModel objects specify the general appearance of Text objects and of Overlay Objects that display text OverlayText and OverlayClock as well as BillboardText A TextModel object can therefore be used as a style class with all instances of these text objects that have the same style sharing the same TextModel The table below describes the additional inputs for TextModel objects Key Inputs Keyword Description FontName The font face to be used for text with this TextModel selectable via a drop down menu FontColour The colour of the text defined by a colour keyword or RGB values FontStyle Styles BOLD ITALIC to be applied to the font selectable via a pop up menu DropShadow If TRUE a drop shadow is displayed below the text DropShadowColour The colour of the drop shadow defined by a colour keyword or RGB values The spacing between the text and its drop shadow specified in x y z DropShadowOffset l coordinates 8 4 ScreenPointsModel The ScreenPointsModel is used to determine the graphics for entities that appear as a single or multi segment line such as EntityConveyor and EntityDelay It cannot be used
14. as a fraction of the graph s total height YAxisTitleGap The gap between the y axis labels and the y axis title Expressed as a fraction of the graph s total height YAxisLabelGap The gap between the y axis and its labels Expressed as a fraction of the graph s total height TopMargin BottomMargin Size of the gaps between the respective edges of the outer pane and the graph LeftMargin Expressed as a fraction of the graph s total height RightMargin The TextModel used to determine the font colour and style for the graph title The Title TextModel dropshadow settings are ignored Black Verdana text is used if this input is left blank The TextModel used to determine the font colour and style for the x and y axis Axis Title TextModel titles The dropshadow settings are ignored Black Verdana text is used if this input is left blank The TextModel used to determine the font colour and style for the labels next to LabelTextModel the x and y axis tick marks The dropshadow settings are ignored Black Verdana text is used if this input is left blank GraphColour The colour of the graph background BackgroundColour The colour of the outer pane background BorderColour The colour of the graph border 8 7 DisplayModelCompat JaamSim includes native DisplayModel objects that serve as default visual representations for objects including some graphics for entities commonly modelled in Ausenco s Transportation Logistics Simulator module shipping ra
15. by simulation users are more conveniently specified in other unit systems To this end JaamSim natively supports a number of commonly used units shown in table below Unit Type DimensionlessUnit TimeUnit DistanceUnit SpeedUnit AccelerationUnit MassUnit MassFlowUnit VolumeUnit VolumeFlowUnit AngleUnit AngularSpeedUnit EnergyUnit EnergyDensityUnit SpecificEnergy Unit PowerUnit CostUnit CostRateUnit LinearDensity Unit LinearDensityVolumeUnit DensityUnit PressureUnit ViscosityUnit AreaUnit RateUnit Supported Unit Types and Units Default Unit seconds s meters m meters per second m s meters per squared second m s kilograms kg kilograms per second kg s cubic meters m cubic meters per second m s radians rad radians per second rad s joules J joules per cubic meter J m joules per kilogram J kg watts W dollars dollars per second s kg m m m kg m Pa Pa s m Is Supported Units min h d w y ms us ns m km nmi mi ft in mm m s km h knots mph ft s tonnes kt Mt any mass unit h d y km bbl mbbl mmbbl any volume unit h d y degrees rad h deg s deg h kWh kWh m kWh t kW MW h d t m kt m kPa psi P cP cm mr in h Id w ly Units are mandatory for most numerical inputs with the exception of pure numbers or ratios or in a few cases for older inputs that have not yet been updated with this requireme
16. e Output Viewer displays outputs for a selected object In the Model Builder expand the Basic Objects palette and then drag and drop a SimEntity into the View Window View1 This creates a SimEntity object with a default name SimEntity1 and shape Sphere and automatically selects it denoted by green highlighting as seen below Creating the First Object Basic Objects 45 EntityLogger EntityGenerator eS Server amp Entitysink EntityConveyor EntityDelay BD Assign Queue This object will serve as the prototype for entities that will be handled in the model In the Object Selector select SimEntity1 and press F2 or triple click it to rename the object Note that when renaming an object or later when entering a keyword the Enter button must be pressed when finished otherwise the change will not be completed Objects to Create Model Builder Palette Object Name Basic Objects SimEntity Proto Renaming an Object object Selector 915 Defined Objects Simulation Controls Units Display Models Graphics Objects I DisplayEntity L View Viewi OverlayImage OverlayText OverlayClock Basic Objects J SimEntity 1 1 UE amp E Since the model graphics will be 2 D aside from the Proto entity set the View Control on the Control Panel to be XY Plane so the view becomes bird s eye View Control XY Plane O
17. for Probability Distributions Each of the distributions uses the following standard keywords in addition to the ones that are specific to an individual distribution O 2014 36 38 A A September 8 2014 usenc 2014 36 September 8 2014 Keyword UnitType RandomSeed GlobalSubstreamSeed MinValue MaxValue JaamSim User Manual Key Inputs Description The unit type for the value returned by the distribtion e g TimeUnit To keep the units consistent for other inputs this input must be set first The random seed to be used by the random number generator The substream number to be used by the random number generator The substream number entered for one probability distribution is applied globally to ALL random number streams in the model The minimum value that can be returned by the distribution A value less than the minimum is rejected and re sampled from the distribution The maximum value that can be retumed by the distribution A value greater than the maximum is rejected and re sampled from the distribution A number of outputs are standard to all distributions Output Name CalculatedMean CalculatedStandardDeviation NumberOfSamples SampleMin SampleMax SampleMean SampleStandardDeviation Outputs Description The mean value for the distribution calculated directly from the inputs Ignores the values entered for the MinValue and MaxValue keywords The standard deviation for the distri
18. for re positioning re sizing or rotating The selected object is indicated by a green rectangle that encompassed the object Green handles are also provided to allow the object to be re sized or rotated Left Click Moves the object parallel to the xy plane holding its z coordinate constant Control Lett Drag following the pointer Moves the object parallel to the z axis holding its x and y coordinates constant Shift Control Left Drag following the pointer Control Left Drag on a Resizes rotates the object The selected object is re sized or rotated using the Handle selected handle Moving and Re shaping Linear Objects In addition to the standard controls described above linear objects such as an Arrow can be re shaped by adding and removing joints and by moving individual joints The actions for linear objects are described in the following table O Ausenc 2014 36 September 8 2014 Mouse Keyboard Action Left Click on the Line Control Left Drag on the Line Shift Control Left Drag on the Line Control Left Drag on a Handle Shift Control Left Drag on a Handle Alt Control Left Click on the Line Shift Alt Control Left Click on a Handle Context Menu JaamSim User Manual Moving and Re shaping Linear Objects Effect on the Object Selects the line The line under the pointer is selected for input output viewing and for re positioning re sizing or rotating The s
19. is divided into three rows consisting of the menu bar tool bar and status bar which are described in the following sections Menu Bar File Clicking on the File entry displays a menu with actions related to saving and loading model input configuration files File Menu Entry Description New Launches a new blank model with no objects defined Open Loads a saved configuration from file Save Saves the model under the present input configuration file name Save As Saves the current model as a new input configuration file Import Imports a 3D model image ofa supported format as a ColladaModel ImagelModel and also creates a corresponding DisplayEntity Print Input Report Prints the present inputs in a standard file format inp Exit Closes all windows and exits JaamSim Tools Clicking on the Tools entry displays a menu allowing the user to bring up each of the windows that make up the JaamSim graphical user interface O i Ausenc 2014 36 September 8 2014 JaamSim User Manual Tools Menu Entry Description Show Basic Tools Shows the four main tools Mode Builder Object Selector Input Editor and Output Viewer Close All Tools Closes all of the tools that are open Model Builder Drag and drop creation and placement of simulation objects Object Selector Tree listing of all objects in the present simulation model Input Editor View and edit keyword inputs for the selected simulation object Output Viewer Key out
20. of the values that were observed The estimated standard deviation of the sample average O Ausenc 2014 36 September 8 2014 JaamSim User Manual 11 Advanced Topics A number of more advanced features of JaamSim are discussed in this section List of topics and objects e Expressions and Attributes Editing the Configuration File Launching in Batch Mode ScriptEntity VideoRecorder 11 1 Expressions and Attributes Mathematical Expressions Many keywords that expect a number can also accept other types of inputs that return a number These inputs include objects such as a Probability Distribution a TimeSeries and mathematical expressions A probability distribution or time series can be specified simply by entering the object name Mathematical expressions are entered using the following syntax an expression is enclosed in single quotes if it contains any spaces object names are enclosed by square brackets spaces in an expression are optional outputs and attributes of an object are referenced using a dot notation ObjectName OutputName output and attributes can be chained when necessary using the format ObjectName OutputName1 OutputName2 the reserved string this is used to refer to the object evaluating the expression rules for mathematical order of operation are respected units are enclosed by square brackets all calculations must respect Units For example two values must have the same
21. of time and can be a constant value a TimeSeries a Probability Distribution or a mathematical expression Default Graphic amp O Ausenc 2014 36 September 8 2014 Keyword Description AttributeDefinitionList NextComponent Operating ThresholdList FirstArrival Time InterArrivalTime PrototypeEntity MaxNumber Output Name NumberProcessed ProcessingRate NumberGenerated 10 5 Server JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which the generated entity is passed A list of threshold objects that must all be open for operation to proceed Operation is stopped if any one of the thresholds is closed The time at which the first entity is to be generated The elapsed time between one generated entity and the next The entity to be copied by the generator The maximum number of entities to be generated Outputs Description The total number of entities that have been generated The rate at which entities are generated entities per second The total number of entities generated by this generator The Server object processes an incoming entity and then passes it to the next object Entities that are waiting to be processed are held by a Queue object identified by the keyword WaitQueue All entities received by the Server first pass through this Queue object even if the Server i
22. output in terms of hours instead of seconds the SI unit for time This change can be accomplished by setting the PreferredUnit keyword for a TimeUnit to h Any TimeUnit can be used for this purpose The same result would be obtained by using s seconds h hours d days or any other TimeUnit Changing the PreferredUnit keyword for one TimeUnit changes this keyword s value for all TimeUnits O Ausenc 2014 36 September 8 2014 JaamSim User Manual 7 Graphics Objects Palette Graphical Objects are used to create 3D objects pictures text graphs arrows and other visual components needed to visualise and monitor a simulation List of objects DisplayEntity Text Overlay Objects BillboardText Arrow Graph View 7 1 DisplayEntity The DisplayEntity is the basic 3D graphical object in JaamSim All JaamSim objects that have graphics are sub classes of DisplayEntity A DisplayEntity dragged and dropped from the Model Builder can be used to display a static object such as a 3D shape or a 2D picture The graphical appearance of a DisplayEntity and its subclasses is determined by its DisplayModel The two objects work together to generate an object s display In general the DisplayEntity determines what is displayed while its DisplayModel determines how it is displayed A number of different subclasses of DisplayModel are available to match the various subclasses of DisplayEntity The DisplayModel keyword
23. section discusses the editing the configuration file cfg file outside of the GUI The file is in plain text and can be created or modified using a text editor We recommend the use of Notepad an open source editor available for download at ww notepad plus plus org Basic Structure A JaamSim input configuration file consists of a series of lines akin to a scripting language Each line consists of a combination of object names keywords and values contained within braces One or more spaces are used to separate these elements Braces are also used to denote sets of arguments within the outer braces required for arguments in general Blank lines and extra whitespace are ignored by JaamSim Comments beginning with a double quote can be used to document the input files There is no need to use a double quote mark to end the comment since JaamSim automatically recognizes the end of a comment with the end of the line If a comment extends for several lines each line must start with a double quote Object Definitions In JaamSim an object is initialized by a Define statement The statement contains Define followed by the object type and the object name enclosed by braces Multiple objects can be defined at the same time provided that they are of the same type For instance the following two lines define respectively a single Arrow object and three Arrow objects Define Arrow SingleArrow Define Arrow Arrowl Arrow2 Arrow3 O
24. unit type if they are to be added e unit conversions are performed automatically For example a distance divided by a time results in a speed The following are examples of syntactically valid expressions They assume that the present object has an output OutputA and another entity Entity1 has an output OutputB 11 2 3 Ma ee E 4 l 2 this OutputA l 2 Entityl OutputB 1 m 2 km 2 m Als The mathematical functions min max and abs can also be used in expressions For instance 2 max 3 4 T 2 max l this OutputA 3 Entityl OutputB Logical operations can also be performed in expressions using the standard Java symbols Logical Operators Keyword Description Equal to l Not equal to lt Less than lt Less than or equal to gt Greater than gt Greater than or equal to amp amp Logical AND operation I Logical OR operation Logical NOT operation O 2 Ausenc 2014 36 September 8 2014 JaamSim User Manual For conditional operations all non zero results are interpreted as TRUE while zero is interpreted as FALSE The following are examples of syntactically valid logical expressions this OutputA gt 1 this OutputA gt 1 amp amp Entityl OutputB 0 Conditional operations are also implemented using the ternary operator using the following syntax condition_expression true_expression false_expression
25. use Include statements to create simple incremental configuration files for the additional runs Include Base File Basecase cfg Arrowl Width 2 0 This example includes the contents of Basecase cfg and modifies the already defined object Arrow1 keyword Width value to 2 0 Note that the changes from the base case configuration must appear after the Include statement These simple configuration files are useful because it is easy to tell exactly how the configuration differs from the base case configuration Group Objects Group objects bundle multiple objects together to simplify inputs Instead of referring to a long list of objects a single group is used instead The group may be used to set the value for the keyword for all members instead of setting the value for each member of the group Certain keywords also accept Group objects as values Considerable caution must be exercised when using Group objects because they do not behave in the same way as other JaamSim objects Although they are defined in the same way as other objects they are used only as an input convenience When JaamSim reads the configuration file it replaces each group by its list of objects Groups are ignored once the configuration file has been read Key Inputs Keyword Description List A list of names of the objects included in the list enclosed by braces Example The following example demonstrates the use of groups Define Arrow Define Group ArrowL
26. which specifies a list of Threshold objects such as SignalThreshold TimeSeriesThreshold or ExpressionThreshold All of the specified Threshold objects must be open for the EntityGate to be open O Ausenc 2014 36 September 8 2014 Keyword Description AttributeDefinitionList NextComponent Operating ThresholdList WaitQueue ReleaseDelay InitialState Output Name obj NumberAdded NumberProcessed ProcessingRate 10 18 EntitySignal JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a received entities is passed A list of Threshold objects that determine whether the EntityGate is open or closed A Queue object in which to hold incoming entities that are blocked when EntityGate is closed The time required to remove each entity from the Queue The EntityGate s state at the start of the simulation run TRUE open FALSE closed Outputs Description Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The EntitySignal object sets the state of a SignalThreshold object when it receives an incoming entity The SignalThreshold and its new state are specified by the TargetSignalThreshold and NewState keywords respectively Default Graphic P K
27. yellow khaki lightgoldenrod palegoldenrod darkkhaki banana gold goldenrod darkgoldenrod brick floralwhite seashell oldlace linen antiquewhite papayawhip blanchedalmond eggshell bisque moccasin navajowhite wheat peachpuff tan burlywood melon sandybrown cadmiumyellow carrot orange flesh cadmiumorange Colour R 85 107 128 255 255 250 255 255 245 255 240 255 238 189 227 255 218 184 156 255 255 253 250 250 255 255 252 255 255 245 E N R 2 8 N on a 237 255 N on a 255 107 142 128 255 255 250 248 250 245 255 230 236 232 183 207 215 165 134 102 250 245 245 240 235 239 235 230 228 228 218 180 184 168 164 153 145 128 125 97 67 47 35 240 224 210 220 205 220 140 139 170 107 87 32 11 31 240 238 230 230 215 213 205 201 196 181 173 179 185 140 135 105 18 33 Colour Name gray40 gray39 gray38 gray37 gray36 gray35 gray34 gray33 gray32 gray31 gray30 gray29 gray28 gray27 gray26 gray25 gray24 gray23 gray22 gray21 gray20 gray19 gray18 gray17 gray16 gray15 gray14 gray13 gray12 gray11 gray10 gray9 gray8 gray7 gray6 gray5 gray4 gray3 gray2 gray1 black Colour Ausenc JaamSim User Manual R GB 102 102 102 99 99 99 7 FF 97 4 4 4 92 92 92 89 89 89 87 87 87 84 84 84 82 82 82 7 79 79 7 77 7 74 7 74 n 71 71 69 69 69 6 66 pp 4 64 64 61 61 6 5
28. 219 gray98 250 250 250 lightslateblue ee 132 112 255 gray97 247 247 247 mediumslateblue E 123 104 238 gray96 245 245 245 slateblue E 109 0 205 gray95 242 242 242 darkslateblue E e oa 139 gray94 240 240 240 ghostwhite 248 248 255 gray93 237 237 237 lavender 230 230 250 gray92 235 235 235 blue 255 gray91 232 232 232 darkblue 139 gray90 229 229 229 naw E o o iz gray89 227 227 227 midnightblue 5 5 2 gray88 224 224 224 cobalt Wy 171 gray87 22 222 290 royalblue Me 105 225 gray86 219 219 219 comflowerblue wu gray85 217 217 217 lightsteelblue 176 196 222 gray84 214 214 214 lightslategray ee 119 136 153 gray83 212 212 212 slategray Dy 112 128 1m gray82 209 209 209 dodgerblue Bo 14 25 gray81 207 207 207 C 2014 36 65 A a September 8 2014 usencc JaamSim User Manual Colour Name Colour R G B Colour Name Colour R G B aliceblue 240 248 255 gray80 204 204 204 powderblue 176 224 230 gray79 201 201 201 lightblue 173 216 230 gray78 199 199 199 lightskyblue BE 135 206 250 gray77 196 196 196 skyblue 185 206 235 gray76 194 19 194 deepskyblue TO o an 255 gray75 191 19 191 peacock ee s 19 201 gray74 189 189 189 steelblue E o 130 180 gray73 186 186 186 darkturquoise 0 206 209 gray72 184 184 184 cadetblue D 18 10 gray71 181 181 181 azure 240 255 255 gray70 179 179 179 lightcyan 224 255 255 gray69 176 176 176 paleturquoise 187 255
29. 4 JaamSim User Manual Gen Inputs Tab Keyword Value Key Inputs InterArrivalTime GenlATDist Save the model again and press Play Observe that Proto entities are generated randomly and there are now times where Proto entities are waiting in ServQueue to be processed Simulation with a Probability Distribution Viewi 10 x Model Title ka gt 2014 Jan 01 00 01 22 721 Au senco Congratulations you have successfully constructed a JaamSim simulation model 2 Ausencs C 2014 36 September 8 2014 JaamSim User Manual 4 Graphical User Interface The graphical user interface GUI for JaamSim is also used by TLS and by any other simulation software based on JaamSim The interface consists of the Control Panel one or more view windows the Model Builder the Object Selector the Input Editor and the Output Viewer List of interface elements Control Panel View Windows Model Builder Object Selector Input Editor Output Viewer 4 1 Control Panel e 6 6 o o The Control Panel provides a number of run controls and output displays to monitor and control the progress of a simulation run The control panel for an example simulation run is shown in the figure below JaamSim Control Panel aici Be Tools yews Options Help Bl seee ieai Time View Controk Isometric XY Plane SmdatonTme ra 2040 00 1 SpeedUp 14 334 545 Time Remaining mins 0 0 Pos 2 The panel
30. 9 59 p9 56 56 5 5 5 54 51 51 51 43 48 48 46 46 46 434343 M41 y 38 38 38 36 36 36 33 33 33 31 31 31 28 28 28 26 26 2 23 23 23 20 20 20 18 18 18 15 15 145 13 43 43 10 10 10 8 8 8 5 5 5 3 3 3 0 0 0 O JaamSim User Manual 13 Basic Example Input Configuration File RecordEdits Define ColladaModel Grid100x100 Axis Define SimEntity XY Grid Proto Define View Viewl Define ImageModel AusLogoModel Define OverlayImage AusLogo Define TextModel TitleTextModel ClockTextModel Define OverlayText Title Define OverlayClock Clock Define EntityGenerator Gen Define EntityConveyor GenToServ ServToSink Define Server Serv Define EntitySink Sink Define Queue ServQueue Define ExponentialDistribution ExponentialDistributionl Simulation Description Simulation run control inputs Simulation SimulationTimeScale 3600000 Simulation RealTimeFactor 1 Simulation RealTime TRUE Simulation ShowModelBuilder TRUE Simulation ShowObjectSelector TRUE Simulation ShowInputEditor TRUE Simulation ShowOutputViewer TRUE Simulation ShowPropertyViewer FALSE Simulation ShowLogViewer FALSE Grid100x100 ColladaFile lt res gt shapes grid100x100 dae XY Grid Description Grid for the X Y plane 100 mx 100 m XY Grid Size 100 100 m XY Grid DisplayModel Grid100x100 XY Grid Movabl
31. JSB file can be exported by right clicking on a ColladaModel in the Object Selector and selecting Export 3D Binary File jsb A present the ColladaModel must have been created from a DAE file Support for OBJ and JSM files will be added in a future version of the software Note that the Ausencs 2014 36 September 8 2014 JaamSim User Manual exported JSB will look for the same textures as the DAE file and that these should be located in the same relative position to the JSB file as they were to the DAE file Managing 3D assets can be complicated because of the large file sizes and the need to provide separate files for the textures We recommend that the user place each 3D asset and its texture files in its own ZIP file This approach greatly reduces the number and size of the files being handled and ensures that the files can be moved between computers without breaking the file paths Note that it is often necessary to edit the DAE file with a text editor such as Notepad to convert any absolute file paths for texture file to relative ones The table below describes the additional inputs for ColladaModel objects Key Inputs Keyword Description A file path to the DAE OBJ JSM and JSB file to be used for this display model A ZIP file containing one of these files and its related texture files can also be used and is the recommended option for this input The file path must be enclosed in single quotes if it contains spaces
32. Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity ne A mathematical expression that retums a boolean value TRUE or 1 open OpenCondition FALSE or 0 closed Graphics Keyword Description OpenColour The colour to display when the ExpressionThreshold is open ClosedColour The colour to display when the ExpressionThreshold is closed ShowWhenOpen if TRUE the ExpressionThreshold is displayed when it it open If FALSE it is hidden when open ShowWhenClosed If TRUE the ExpressionThreshold is displayed when it it closed If FALSE it is hidden when closed 10 25 TimeSeriesThreshold The TimeSeriesThreshold object varies its state between open and closed depending on the state of a TimeSeries object The TimeSeries to be monitored is specified by the TimeSeries keyword Trigger levels are determined by its MinOpenLimit and MaxOpenLimit keywords For the TimeSeriesThreshold to be open the present value for the TimeSeries must be within the range specified by these two keywords The LookAhead and Offset keywords provide additional flexibility e f a non zero value is specified for the LookAhead keyword then the value for the TimeSeries must be within the range specified by the MinOpenLimit and MaxOpenLimit keywords over the entire LookAhead duration starting from the present time e f a non zero value is specified for the Offset keyw
33. RecordEdits Computer written inputs Everything that appears after the RecordEdits statement is written by the computer The Save functionality in JaamSim is disabled when an input file is loaded without a RecordEdits statement In this case the Save As operation adds a RecordEdits statement to the end of the original configuration file and then writes out the new inputs 11 3 Launching in Batch Mode JaamSim models can be executed in batch mode with minimized graphics Batch mode is useful when only the output reports are required or when a series of runs are to be executed without user intervention The model can also be launched configured and started automatically from the command line or a batch file using the command JaamSim exe runl cfg tags Here runl cfg is the name of the input file to be loaded and tags are the optional tags for the run Multiple tags must be separated by a space The following tags are supported Batch Mode Run Tags Tag Description Start the simulation immediately after the input file has been read and exit when the run has IR ieaieial completed This tag is useful for batch file execution Minimize the graphical user interface making the simulation run faster when visualizations m or minimize A E S are not required for instance in overnight simulation runs A series of simulation runs can be executed one after the other by using a batch file that contains a series of
34. S Ausenc 2014 36 September 8 2014 Then adjust the viewing position as desired using the following actions JaamSim User Manual View Adjustments Mouse Keyboard Action Effect on Viewing Position Left Drag Pan in the XY plane Scroll Wheel Zoom in or out Example of a Configured View zox Model Title A 2014 Jan 01 00 90 00 000 Au senco Create the rest of the objects for this model from the Basic Objects palette in the Model Builder in the following order from left to right EntityGenerator EntityConveyor Server EntityConveyor EntitySink and rename them using the same method as for the Proto entity Object EntityGenerator EntityConveyor Sener EntityConveyor EntitySink Queue Renamed Objects Name Gen GenToServ Serv ServToSink Sink SerQueue O Ausenc JaamSim User Manual The re positioning of these objects will be covered in a later step The model so far should look similar to the Model Layout below depending on how the viewing position was adjusted Save the model from the File menu on the Control Panel with the name JaamSimBasicExample cfg when prompted We recommend saving regularly when building models Model Layout Viewi 4 l0j x Model Title 2014 Jan 01 00 00 00 000 Au senco 3 2 Step 2 Putting the Objects Together Now that the objects have been placed in the model they need to be set to interact with one another to
35. The number of entities to pack into each EntityContainer The time required to pack each entity Outputs Description Entity last received Number of entities received The total number of EntityContainers that have been created The rate at which EntityContainers have been created NumberProcessed Total Time The Unpack object is used to remove the entities from incoming EntityContainers Entities are unpacked one by one from the EntityContainer in same order as they were packed The time to unpack each entity is specified by the ServiceTime keyword EntityContainers are destroyed automatically once they have been unpacked Default Graphic 3 Keyword Description AttributeDefinitionList NextComponent OperatingThresholdList WaitQueue SeniceTime 2014 36 September 8 2014 Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which the unpacked entities are passed A list of Threshold objects which must be open for the unpacking operation to proceed The Queue in which the arriving EntityContainers are stored while they wait to be unpacked The time required to unpack each entity O Ausenc 2014 36 September 8 2014 JaamSim User Manual Outputs Output Name Description obj Entity last received NumberAdded Number of EntityContainers received NumberProcessed The total number of entities that have bee
36. User Manual Ausencs Ihe forefront of simulation 2014 36 September 8 2014 JaamSim User Manual 1 Introduction JaamSim Java Animation Modelling and Simulation is a discrete event simulation software package developed by Ausenco as the foundation of all our simulation applications JaamSim represents the lessons learned from simulation projects we have performed around the world for more than 35 years Further background information on JaamSim can be found in the JaamSim blog www jaamsim com blog This User Manual documents the user interface and basic objects provided with JaamSim These features are common to all simulation models created with this software Documentation for application specific objects such as those found in Ausenco s Transportation Logistics Simulator TLS is found in the manuals for the corresponding modules JaamSim is free open source software licensed under GPLv3 The latest version of the software and manuals can be downloaded from the JaamSim website ww jaamsim com The source code is published on GitHub www github com AusencoSimulation JaamSim 1 1 Features The key feature that makes JaamSim different from commercial simulation software is that it allows the user to develop new palettes of high level objects for a given application in a standard programming language Java Objects created in this way automatically have 3D graphics are available in the drag and drop interface and have thei
37. a Text object with its name and RelativeEntity keywords set to the selected object Selects the object and centers the current View on it The Model Builder provides palettes of objects that can be dragged and dropped to construct a new model or to modify an existing one The figure below shows the Model Builder with the Graphical Objects palette opened ready for dragging and dropping O 2 Ausenc 2014 36 September 8 2014 JaamSim User Manual Model Builder 2101 m Graphics Objects DisplayEntity Text OverlayImage OverlayText OverlayClock Arrow Graph Y L Probability Distributions fl Basic Objects gt Once an object has been created by dragging and dropping it from the Model Builder into a view window its inputs are entered using the Input Editor When a model is saved JaamSim generates an input configuration file that contains all of the objects that have been created along with their input values JaamSim includes a number of built in palettes of objects Simulation Controls Units Graphics Objects Display Models Probability Distributions Basic Objects Calculation Objects Fluid Objects The Simulation Controls Units and Display Models palettes contain objects that do not have a graphical representation and cannot be dragged and dropped by the user They appear in the Object Selector but not in the Model Builder The remaining palettes contain the standard objects that ar
38. already defined in the model or to assign inputs to newy defined objects When an object is selected its parameters appear in the Input Editor window grouped under a number of tabs If a keyword has a default value assigned it is shown in the Default column Hovering the mouse cursor over a keyword will display a tooltip containing a brief description of the keyword and an example input The figure below shows the Input Editor with the tooltip for Size Input Editor with Keyword Tooltip Mouseover input Editor Queue 1 Position 0 0 0 0 0 0 m 3 077688 0 773406 0 000000 m Alignment l 0 0 0 0 0 0 nn Size 1 0 1 0 10m 1 000 1 000 0 0 m ientati 0 0 0 0 0 0 rad Keyword Size Category Basic Graphics D ipti EEO T eee If only the x and y coordinates are given then the z dimension is assumed to be zero Example Object1 Size 15 120m The example input shown in the figure is given in the configuration file s format The entry to place in the Input Editor is the text appearing between the braces For the example shown in the figure the entry would be 15 12 Om Entering and Editing Keyword Inputs Keywords are modified by clicking the Value column and entering a new value including units Numbers must be entered without spaces or commas and Boolean keywords must take the value TRUE or FALSE case sensitive If an entry is made in the Value column it will overwrite the default If an input is not valid an error
39. an The camera is moved along the z axis from its present position so that the pointer stays fixed on the same object in the scene If no object is under the Shift Left Drag pointer then the point on the xy plane is used The point of interest is reset to the pointer position Right Drag Orbit The camera orbits left right and up down around the point of interest following the mouse movement Shift Richt Dra Look around The camera looks left right and up down following the mouse 9 9 movement The point of interest is unchanged Moving and Re sizing Objects Individual objects can be moved around using mouse controls that are analogous to the camera controls To avoid moving an object accidentally it is necessary to press the Control key during any movement After selecting an object in the Object Selector or by clicking it in a view window its position size and orientation can be manipulated interactively by pressing the Control key and dragging the entire object a corner of the object or its rotation handle using the mouse By default dragging an object moves it in the xy plane An object can be moved in the z direction by holding down both the Control and Shift keys and dragging the object up and down These actions are described in more detail in the following table Moving and Re sizing Objects Mouse Keyboard Action Effect on the Object Selects the object The object under the pointer is selected for input output viewing and
40. ary y axis When the Views menu is selected from the menu bar a list of View objects is displayed Each View object consists of an imaginary camera positioned in the world and a window in which to display the image Clicking one of these objects will display the View in a new window or bring the view window into focus if already displayed The graphical positions of objects are not used by any of the simulation model calculations All graphics are for display purposes only Keyword ViewCenter ViewPosition WindowSize WindowPosition TitleBarText ShowWindow Key Inputs Description The position in space that the View window is looking at The position in space that the View window is looking from The size of the view window in pixels The position of the view window in pixels with respect to the upper left hand corner of the computer screen Text to place in the title bar of the view window If TRUE the view window is displayed on screen O Ausenc 2014 36 September 8 2014 JaamSim User Manual 8 Display Models Palette The graphical appearance of a DisplayEntity and its subclasses is determined by its DisplayModel The two objects work together to generate an object s display In general the DisplayEntity determines what is displayed while its DisplayModel determines how it is displayed A number of different subclasses of DisplayModel are available to match the various subclasses of DisplayEntity
41. bject by triple clicking on the name in the Object Selector entering the new name and pressing Return key e Use the Input Editor to assign a 3D file to the ColladaFile keyword for a ColladaModel or a picture file to the ImageFile keyword for an ImageModel s Use the Input Editor to select the DisplayEntity s new DisplayModel keyword The easiest way to create a new DisplayEntity for a 3D object or an image is to use the Import function provided in the Control Panel under File All objects intended for visualization in a model display window in JaamSim have a set of Basic Graphics keywords used to define their appearance These are found in the Basic Graphics tab of the Input Editor when the object is selected O Ausenc JaamSim User Manual Basic Graphics Inputs Keyword Description Position The point in the region at which the alignment point of the object is positioned Alignment The point within the object about which its Position keyword is defined expressed with respect to a unit box centered about 0 0 0 The size of the object in x y Z coordinates When two coordinates are given it Size is assumed that z 0 When the size is changed the coordinates of the center are held fixed and the eight corners are moved Orientation The three Euler angles defining the rotation of the object An object with respect to which the Position keyword is referenced If that object is Relativeentity moved any obje
42. bution calculated directly from the inputs Ignores the values entered for the MinValue and MaxValue keywords The total number of samples retumed by the distribution The minimum of the samples returned by the distribution The maximum of the samples retumed by the distribution The average of the samples retumed by the distribution The standard deviation of the samples retumed by the distribution 9 4 Distributions that Return an Object Two distributions are available that return an object instead of a number Distribution Name RandomSelector EntitlementSelector Distributions that Return an Object Description Randomly selects an object from a list of objects and probabilities Selects an object from a list of objects and probabilities based on an entitlement algorithm The object retumed is the one that minimizes the difference between the actual number retumed for that object and the expected number to be returned based on the probabilities O S Ausenc JaamSim User Manual 10 Basic Objects Palette The Basic Objects palette contains a number of simple objects that can be used to create process flow type models Many of these objects are similar to the ones provided by commercial off the shelf simulation software such as Arena and Simio The TimeSeries and TimeSeriesThreshold objects are also used extensively by TLS models The use of these objects in TLS are described in the user manuals for that software
43. by other objects such as DisplayEntity that are intended for 3D or 2D graphics ScreenPointsModel has no inputs other than the standard ones for DisplayModels 8 5 ArrowModel The ArrowModel is used to determine the graphics for the Arrow entity Key Inputs Keyword Description ArrowSize The x y Z dimensions of the arrowhead 8 6 GraphModel The GraphModel is used to determine the presentation style and proportions for various types of Graph objects To make the graph scalable to any size all length measurements are specified as fraction of the graph s total height 2014 36 35 A September 8 2014 USENES 2014 36 September 8 2014 JaamSim User Manual Key Inputs Keyword Description TitleTextHeight Text height for the graph title Expressed as a fraction of the graph s total height XAxis Title TextHeight Text height for the x axis title Expressed as a fraction of the graph s total height YAxis Title TextHeight Text height for the y axis title Expressed as a fraction of the graph s total height LabelTextHeight The text height for both x and y axis labels Expressed as a fraction of the graph s total height The gap between the graph title and the top of the graph Expressed as a fraction TitleGap i of the graph s total height XAxisTitleGap The gap between the x axis labels and the y axis title Expressed as a fraction of the graph s total height XAxisLabelGap The gap between the x axis and its labels Expressed
44. ck t m Basic Objects Description Title for the simulation model AttributeDefinitionList Format abc setting Started with JaamSim OutputName UW E 2 E 2 i Unit TextHeight 15 FailText Press Play again and Stop the simulation when ready to proceed 6 Ausencs C JaamSim User Manual Adjusting Model Graphics View Br Iei Getting Started with JaamSim Ausenco 2014 Jan 01 00 00 04 460 3 4 Step 4 Adding a Probability Distribution The simulation created thus far is not particularly interesting because the Proto entities are being generated in a uniform sequence To make the model more dynamic we will add a probability distribution to control when each Proto entity is generated From the Model Builder expand the Probability Distributions palette then create and rename an ExponentialDistribution object Renaming the ExponentialDistribution Model Builder Palette Object Name Probability Distributions ExponentialDistribution GenlATDist Also set the following keywords for GenlAT Dist GenlATDist Inputs Tab Keyword Value Key Inputs UnitType TimeUnit Key Inputs MinValue Os Key Inputs MaxValue 10s Key Inputs Mean 2s Now change the InterArrivalTime for Gen to be GenlATDist C 2014 36 12 A A September 8 2014 usencc 2014 36 September 8 201
45. ct connected to it by RelativeEntity will also move DisplayModel The graphical representation of the object Accepts a list of multiple Display Model pay objects for compatibility with level of detail and optional rendering Active If TRUE then the object is active and used in the simulation run Show If TRUE then the object is shown in the simulation view windows If TRUE then the object can be positioned by dragging with the mouse Non Movable S 2 movable objects do not respond to mouse interactions in the View windows 7 2 Text The Text object is used to define static or dynamic text to be displayed in a view window Text objects are used for labelling various parts of the model and for monitoring the status of the model The text displayed by the Text object is determined primarily by its Format keyword Dynamic text can be introduced by including a Java format code such as s in the Format input and specifying the variable to be displayed with the OutputName keyword Use the Output Viewer to identify the outputs that are available for each object If the output is a number with Units the value can be converted from SI to a specified unit through the unit keyword The appearance and style of the text is determined by the TextModel specified by the DisplayModel keyword The default style DefaultTextModel is black Verdana text A new text style can be created through the following steps e Create a new TextModel by right clicki
46. d NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time 10 10 Queue A Queue object defines a location for simulation entities to wait for processing by other simulation entities Unlike many other objects in this palette an entity received by a Queue is not passed automatically to the next object It must wait in the Queue until it is removed by some other object Queues are used in this way by the Server Seize EntityGate Assemble Pack and Unpack objects Default Graphic 2014 36 46 A September 8 2014 usencg Keyword Spacing MaxPerLine PrintReport Output Name QueueLength NumberAdded NumberRemoved QueueLengthAverage QueueLengthStandardDeviation QueueLengthMinimum QueueLengthMaximum QueueLengthDistribution 10 11 Seize JaamSim User Manual Key Inputs Description The amount of graphical space between objects in the queue Maximum number of objects in each row of the queue If TRUE a queue report file QUE file is output summarizing the contents of the queue every time an object is added or removed Outputs Description The present number of objects in the queue The total number of objects that have been added to the queue The total number of objects that have been removed from the queue The average number of objects in the queue The standard deviation of the number of objects in th
47. determines the DisplayModel used by a DisplayEntity A 3D object will require a ColladaModel while a 2D picture will require a ImageModel The inputs for DisplayEntity determine the position size and orientation for the graphical object while the inputs for the DisplayModel determine the shape and appearance of the object One DisplayModel can be shared between multiple DisplayEntities This is an essential feature for the case of complex 3D content built from thousands or millions of triangles In this case a ColladaModel as subclass of DisplayModel stores 3D information that can be shared between multiple DisplayEntities The 3D content is loaded and stored only once even though it is displayed many times in various locations Even in the case of animated 3D content only one ColladaModel is needed to display a different animation state in each location The default appearance of a DisplayEntity is a grey cube Its appearance can be changed by right clicking the DisplayEntity in either a view window or the Object Selector and selecting Change Graphics The user can then select between the available DisplayModels or can create a new DisplayModel by importing a file in one of the supported 3D graphics formats Alternatively the user can create a new DisplayModel through the Object Selector e Create a new DisplayModel by right clicking on an existing ColladaModel or ImageModel in the Object Selector and selecting Duplicate s Rename the new o
48. e FALSE Axis ColladaFile lt res gt shapes axis_text dae Viewl Description Default view window Viewl ViewCenter 0 193139 3 142639 2 866544 m Viewl ViewPosition 0 193139 3 142640 11 526798 m Viewl ShowWindow TRUE Viewl SkyboxImage lt res gt images sky_map_2048x1024 jpg AusLogoModel ImageFile lt res gt images auslogo small png AusLogoModel Transparent TRUE AusLogo Description Ausenco wordmark AusLogo DisplayModel AusLogoModel AusLogo ScreenPosition 10 10 AusLogo AlignRight TRUE AusLogo AlignBottom TRUE AusLogo ImageSize 200 45 TitleTextModel Description Text style for the Title TitleTextModel FontColour 150 23 46 TitleTextModel FontStyle BOLD ClockTextModel Description Text style for the Clock ClockTextModel FontColour 51 51 51 ClockTextModel FontStyle ITALIC Title Description Title for the simulation model Title DisplayModel TitleTextModel Title ScreenPosition 15 15 Title Format Model Title Title TextHeight 18 Clock Description Simulation date and time Clock DisplayModel ClockTextModel Clock ScreenPosition 15 15 Clock AlignBottom TRUE Clock TextHeight 10 Clock StartingYear 2014 Clock DateFormat yyyy MMM dd HH mm ss SSS Proto Position 4 452180 0 540587 0 000000 m Proto Alignment 0 0 0 0 0 5 Proto Size 0 5 0 5 0 5 m Proto DisplayModel Sphere
49. e ISO 8601 standard and can take one of the following three forms e YYYY MM DD e g 2013 08 25 for August 25 2013 e YYYY MM DDTHH mm SS e g 2013 08 25T04 25 00 for 4 25 AM on August 25 2013 s YYYY MM DD HH mm SS e g 2013 08 25 04 25 00 for 4 25 AM on August 25 2013 Additionally timestamps will also accept the full RFC8601 format following the forms s YYYY MM DDTHH mm SS dddddd e g 2013 08 25T 04 25 00 1 for 0 1 seconds past 4 25 AM on August 25 2013 s HHHHHHHH mm SS dddddd e g 50000 00 00 000001 for 1 microsecond past 50 000 hours The first timestamp must occur on January 1 00 00 The year in TimeSeries Value lists does not need to match the Simulation StartDate keyword value the model assumes that both the timestamps and the simulation begin at the same time When the simulation reaches the next timestamp of the TimeSeries object the associated value will be updated in the model If the simulation time is greater than the CycleTime the TimeSeries will repeat from the beginning of the Value list Example Repeated TimeSeries values Define TimeSeries TS O 55 Ausenc 2014 36 September 8 2014 JaamSim User Manual TS UnitType SpeedUnit TS Value 2014 01 01T00 00 00 0 00 km h 2014 01 03T00 00 00 0 76 km h 2014 01 11T00 00 00 0 24 km h TS CycleTime 14d In this example if the simulation started on 2014 01 01 it would take on the new values on January 3 0 76 km h and the
50. e been processed NumberProcessed Total Time The EntityConveyor object moves an incoming entity along a path at a fixed speed and then passes it to the next object The travel time for the EntityConveyor is determined by the TravelTime keyword This time must be a constant value Default Graphic Keyword Description AttributeDefinitionList NextComponent Travel Time Points Width Colour 2014 36 September 8 2014 Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a received entity is passed The time required convey an entity from the start to the end The coordinates for the start intermediate joints and end of the EntityConveyor The width of the line representing the conveyor in pixels The colour of the line representing the conveyor O Ausenc JaamSim User Manual Outputs Output Name Description obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time 10 8 EntityDelay The EntityDelay object delays an incoming entity by a variable duration before passing it to the next object The delay is represented as motion along a line that is similar in appearance to the EntityConveyor object It differs however in that the entities m
51. e needed for many simulation models A JaamSim application such as Ausenco s TLS will include additional palettes of objects created specifically for that application 4 4 Object Selector The Object Selector is an index of all the objects that have been created for the present model including ones that were created automatically by JaamSim Objects are grouped according to their palette and type in a tree format that mirrors the structure of the Model Builder A specific object can be selected either by clicking its node in the Object Selector or by clicking it in a view window The figure below shows the Object selector with the Graphics Objects and DisplayEntity nodes expanded O Ausenc 2014 36 September 8 2014 JaamSim User Manual Object Selector 2101 x Defined Objects Simulation Controls Units Display Models Graphics Objects ib View DisplayEntity XY Grid XYZ Axis 5 OverlayImage Objects that have been created using the Model Builder can be renamed or deleted using the Object Selector Once an object has been selected it can be renamed by clicking on its entry in the Object Selector or by pressing F2 similar to the convention in Windows It can be deleted by pressing the Delete key or by right clicking the object in a view window or the Object Selector and selecting Delete 4 5 Input Editor The Input Editor allows the user to modify inputs for objects
52. e queue The fewest number of objects in the queue The largest number of objects in the queue A list of decimal values summing to 1 0 The first entry is the fraction of time that the queue is empty The second entry is the fraction of time that the queue contains one object and so on The number of entries is equal to the maximum queue length plus one The Seize object allocates one or more units of a specified Resource on receiving an incoming entity If the number of available Resource units is insufficient the received entity is directed to a Queue object identified by the keyword WaitQueue Entities waiting for the same Resource at more than one Seize object are processed on a first in first out basis Default Graphic Keyword Description AttributeDefinitionList NextComponent Resource NumberOfUnits WaitQueue 2014 36 September 8 2014 Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a received entity is passed The Resource to be seized The number of units of the Resource to be seized A Queue object in which to hold entities that are waiting for sufficient Resource units to be available O Ausenc 2014 36 September 8 2014 Output Name obj NumberAdded NumberProcessed ProcessingRate 10 12 Release JaamSim User Manual Outputs Description Entity last received Number of entities
53. elected line tums green indicating it has been selected and green handles appear at each joint in the line Moves the entire line in the xy plane The selected line is moved in a plane parallel to the xy plane following the pointer Moves the entire line along the z axis The selected line is moved along the z axis following the pointer Moves location of the joint in the xy plane The lines on either side of the joint adjust to following the joint Moves the location of the joint along the z axis Adds a new joint and Handle to the line Deletes the joint and re connects the joints on either side of the deleted joint Right clicking in the view window generates a menu listing all objects whose graphical representation lies under the mouse cursor Selecting an object here or in the case that there is only one object underneath the mouse cursor generates a submenu with the following entries Menu Item Input Editor Output Viewer Property Viewer Duplicate Delete Change Graphics Add Label Center in View 4 3 Model Builder Context Menu Entries Description Selects the object and opens its Input Editor window Selects the object and opens its Output Viewer window Selects the object and opens its Property Viewer window Creates a copy of the selected object in the current view window Deletes the selected object Opens a dialog box to select a new DisplayModel graphical representation for the selected object Creates
54. er 8 2014 Tool Bar Item Run Pause Simulation Stop Simulation Pause at Real Time Real Time Multiplier View Controls JaamSim User Manual Run Controls Description Starts pauses and resumes the simulation run Stops the simulation run and prepares it for re starting at time zero Entering a value here while the model is already paused or stopped in hours of simulated time pauses the simulation at the specified time If pressed the simulation speed is held to a constant multiple of wall clock time The ratio of simulated time to wall clock time that is used when the Real Time feature is active Two buttons are provided to adjust the camera position Tool Bar Item Perspective XY Plane View Controls Description Moves the camera for the active view window to give the viewer a sense of depth in all dimensions Moves the camera for the active view window to give a bird s eye view directly above the x y plane of the simulation Note that both of these view options provide full 3D perspective graphics Only the camera position is changed when a button is clicked Status Bar The Status Bar consists of indicators to illustrate the progress and status of the simulation run Status Bar Item Simulation Time Progress Bar Speed Up Time Remaining Pos 4 2 View Windows Status Bar Description The number of simulated hours elapsed Percentage of simulated time completed The ratio of simulated time
55. eyword Description AttributeDefinitionList NextComponent TargetSignalThreshold NewState Output Name obj NumberAdded NumberProcessed ProcessingRate Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a received entity is passed The SignalThreshold object whose state will be changed by this EntitySignal The state to be set for the SignalThreshold TRUE open FALSE closed Outputs Description Entity last received by the EntitySignal Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time 7 Ausencs 2014 36 September 8 2014 10 19 EntityContainer JaamSim User Manual The EntityContainer object is used to store a collection of entities for subsequent processing as a unit EntityContainer is a sub class of SimEntity and consequently includes the State output variable It can be passed to any object that can accept a SimEntity The Pack object is used to place entities in generated EntityContainers The Unpack object is used to remove the entities and to destroy the EntityContainer Default Graphic Keyword Description AttributeDefinitionList Spacing MaxPerLine Output Name State 10 20 Pack Key Inputs Description Optional free form text that describes the object User defined outputs to be added
56. eywords described below that control optional rendering and scaling at different drawing ranges Key Inputs Keyword Description VisibleViews A list of Views for which this Display Model is shown If empty the model appears on all views A list of two values for the minimum and maximum distance from the camera this DrawRange bende iad object is visible ModelScale A list of three multiplicative factors by which to scale the model in the x y and z dimensions respectively 8 1 ColladaModel ColladaModel objects are used to display custom 3D graphics in a simulation model The COLLADA file format DAE is an interchange file format used for 3D graphics Any 3D object such as a DisplayEntity and most of its sub classes can accept a ColladaModel as its DisplayModel A number of other 3D formats can be used in addition to Collada At the present time JaamSim supports DAE OBJ JSM and JSB formats as well as Zipped versions of these files ZIP The JSM and JSB formats are specific to JaamSim s The JSM format was introduced to allow 3D objects to be animated These files can be created using a plug in for Blender an open source 3D graphics program Animation is still in the early stages of development at the present time Please contact us for more information if you wish to use this feature e The JSB format is a binary format that allows complex 3D objects to be loaded much faster than is possible with the DAE and OBJ formats A
57. generate Gen transport GenToServ ServToSink process Serv and consume Sink Proto entities This is done by assigning values to the appropriate keywords for each object First connect the appropriate objects together by setting the following keywords Object Connections Object Keyword Value Gen NextComponent GenToServ GenToServ NextComponent Serv Serv NextComponent ServToSink ServToSink NextComponent Sink As a note hovering the cursor over keywords in the Input Editor will display a brief description of the keyword The mouseover for NextComponent is shown below C 2014 36 7 A A September 8 2014 usencc 2014 36 September 8 2014 JaamSim User Manual Mouseover Keyword Tips Input Editor Queuei lolx 0 0 0 0 0 0 m 4 606188 5 805026 0 000000 m 0 0 0 0 0 0 10 1 0 1 0 m 0 422945 0 315584 0 000000 m Set the time at which Proto entities will be added to the model by Gen and the time they will spend at each stage Transit and Handling Durations Object Keyword Value Gen InterArrivalTime 2s GenToServ Travel Time 1s Serv SeniceTime 1s ServToSink Travel Time 1 55 The Server object requires a Queue object for entities waiting to be processed Set the following keyword to associate ServQueue with Serv Serv Inputs Tab Keyword Value Key Inputs WaitQueue SernQueue Lastly configure Gen to produce copies of Proto which is done by setting the following keyword Gen In
58. he unit to be used for the x axis The minimum value for the x axis The maximum value for the x axis The interval between x axis labels The Java format to be used for the tick mark values on the x axis A list of time values between StartTime and EndTime where vertical gridlines are inserted Colour of the vertical gridlines or a list corresponding to the colour of each gridline defined in XLines defined using a colour name or RGB values Y Axis Keywords Description Title text for the primary y axis The unit to be used for the primary y axis The minimum value for the y axis in units of the target method The maximum value for the y axis The interval between y axis labels The Java format to be used for the tick mark values on the y axis A list of values at which to insert horizontal gridlines Colour of the horizontal gridlines defined using a colour name or RGB values O a Ausenc 2014 36 September 8 2014 Keyword SecondaryY Axis Title SecondaryY AxisUnit SecondaryY AxisStart SecondaryYAxisEnd SecondaryY AxisInterval SecondaryY AxisLabelFormat 7 7 View JaamSim User Manual Secondary Y Axis Keywords Description Title text for the secondary y axis The unit to be used for the secondary y axis The minimum value for the secondary y axis The maximum value for the secondary y axis The interval between secondary y axis labels The Java format to be used for the tick mark values on the second
59. hould point to an entity output to query for the next output For example Tank 1 Product Name retums the name of the product in Tank 1 The unit in which to express the output value Required only for outputs that return a number OutputName Unit TextHeight The size of the font as displayed in the view window 7 3 Overlay Objects Overlay objects are special versions of other objects that are used for graphical display in a simulation model Unlike other display objects the position of overlay objects is referenced to the corner of a view window and so the object does not move when the view is panned or zoomed These objects are useful for labelling view windows or displaying the model name and company logos Examples of Overlay Objects are the default Title Clock and Ausenco logo that are provided automatically when a new model is opened There are three types of overlay objects each corresponding to a different graphical object type The relationship between each overlay object its parent object type and its usage is summarized below Overlay Object and Usage Summary Overlay Object Parent Object Usage Overlaylmage DisplayEntity Static image Logos other graphics OverlayText Text Static of dynamic text Model name states rates OverlayClock Text Current time in the simulation model Each type of overlay object takes the keywords associated with its parent object For instance the Format and TextHeight keywords
60. il and terminal equipment The appearances of these objects are controlled by the additional DisplayModel keywords listed in the table below O i Ausenc 2014 36 September 8 2014 Keyword Shape FillColour OutlineColour Filled Dashed Bold JaamSim User Manual Key Inputs Description The graphical appearance of the object chosen from a selection of pre defined shapes The colour of the filled part of the display model defined by a colour keyword or RGB values The colour of the outline of the display model defined by a colour keyword or RGB values If TRUE the model will appear with a solid colour fill Otherwise the model will appear hollow If TRUE the display model outline will appear as a dashed line If TRUE the display model outline will appear thicker than normal O 2 Ausenc JaamSim User Manual 9 Probability Distributions Palette The probability distributions palette provides a standard selection of theoretical distributions as well as user defined distributions 9 1 Theoretical Probability Distributions The following set of standard probability distributions are available The distributions were coded using algorithms adapted from Simulation Modeling amp Analysis 4th Edition by Averill M Law Random numbers for these distributions are generated by the Multiple Recursive Generator developed by L Ecuyer Good Parameters and Implementations for Combined Multip
61. is entity The next object to which the assembled part is passed A list of Threshold objects which must be open for the assembly operation to proceed The time required to complete the assembly process A set of Queue objects one for each type of sub component to be assembled The index of the queue in which an incoming sub component is to be placed 1 first queue 2 second queue etc The entity whose copies will represent the assembled part Outputs Description Entity last received by the Assemble object Number of entities received The total number of assembled parts that have been created The rate at which assembled parts have been created NumberProcessed Total Time Default Graphic gt The EntityGate object allows incoming entities to be blocked temporarily When the EntityGate is open incoming entities pass through without delay When it is closed incoming entities are directed to a Queue where they are held until such time as the EntityGate opens When the EntityGate opens the queued entities are released one at time separated by a delay determined by the ReleaseDelay keyword This delay does not apply to entities that arrive when the EntityGate is open However if queued entries are still being released an incoming entity is placed at the end of the queue even though the EntityGate is open The EntityGate s state either open or closed is determined by the input to the OperatingThresholdList keyword
62. ist List ArrowList Colour Arrowl Arrow2 Arrow3 ArrowList Arrowl Arrow2 Arrow3 black In this example a group of three Arrow objects is created and used to assign the colour black to each Arrow By using the List keyword a fourth Arrow can be added to the Group e Ausencs 2014 36 September 8 2014 JaamSim User Manual Define Arrow Arrow4 ArrowList List ArrowList Arrow4 ArrowList Colour black RecordEdits Statement The RecordEdits statement is used to preserve the organisation and formatting of a configuration file that has been prepared manually by the user It is usually best to construct a complex model manually using a text editor These inputs are carefully formatted and organised and include comments to document to model design However once this material has been created the easiest way to position the objects and to add graphics such as titles labels etc is through the graphical user interface If the model was then saved all the formatting and comments would normally be lost JaamSim avoids this predicament with the RecordEdits statement On saving JaamSim copies all inputs before the RecordEdits statement line by line to the saved file and then saves all the changes to the model using computer written inputs The following example illustrates this structure Manually prepared inputs Everything before the RecordEdits statement is unchanged when JaamSim saves a file
63. jects can be modified through the Input Editor or deleted using the Object Selector Moving the Camera The basic camera movements are zoom pan and orbit The user can zoom the camera by using the mouse wheel and pan the camera by clicking and dragging the mouse cursor around the view window Dragging the mouse with the right button depressed causes the camera to orbit around the current point of interest These movements are described in more detail below along with a number of other useful camera manipulations O K Ausencs C 2014 36 September 8 2014 JaamSim User Manual View Camera Controls Mouse Keyboard Action Effect on the Camera Selects Point of Interest The point on the surface of the object under the pointer Left Click becomes the point of interest If no object is under the pointer then the point on the xy plane is used Zooms the camera in or out The camera is moved towards or away from the point Scroll Wheel of interest One click moves the camera 10 closer to or farther away from the point of interest XY plane pan The camera is moved in the xy plane from its present position so that the pointer stays fixed on the same object in the scene If no object is under Left Drag the pointer then the point on the xy plane is used The point of interest is reset to the pointer position Movement is restricted to no closer than 1 degree from the horizon to protect the user from an accidental trip to infinity Zaxis p
64. lation RealTime FALSE 11 5 VideoRecorder JaamSim includes functionality to capture still images or videos of simulation models via the VideoRecorder object The length and playback speed of the video is governed by three keywords e CaptureStartTime is the simulated time at which video capture begins e CaptureFrames is the number of frames to capture e Capturelnterval is the simulated time elapsed between frames The video recorder output frame rate is fixed at 30 frames per second The video recorder naturally composites the selected views from CaptureViews onto a surface with dimensions specified in CaptureArea with windows borders not rendered The example inputs below illustrate the capture of a 20 second long video in 1080p resolution spanning 600 hours of simulated time Define VideoRecorder VideoRecorderl VideoRecorderl VideoCapture TRUE VideoRecorderl Capturelnterval ik VideoRecorder1 CaptureStartTime 0h VideoRecorder1 CaptureFrames 600 VideoRecorder1 CaptureArea 1920 1080 VideoRecorder1 SaveVideo TRUE VideoRecorder1 CaptureViews Overview VideoRecorder1 VideoBackgroundColor skyblue O Ausenc 2014 36 September 8 2014 Keyword CaptureStartTime VideoBackgroundColor CaptureFrames Capturelnterval Savelmages SaveVideo CaptureArea CaptureViews VideoName JaamSim User Manual Key Inputs Description The simulated time at which video capture begins The backgro
65. le Recursive Random Number Generators Operations Res 47 159 164 1999a Supported Probability Distributions Distribution Name Description UniformDistribution samples with a constant probability between a minimum and maximum TriangularDistribution Generates samples from a triangular distribution between a minimum and maximum value The distribution peaks at its mode NormalDistribution Generates samples from a normal distribution ExponentialDistribution Generates samples from a negative exponential probability distribution ErlangDistribution Generates samples from an Erlang probability distribution GammabDistribution Generates samples from a Gamma probability distribution BetaDistribution Generates samples from a Beta probability distribution WeibullDistribution Generates samples from a Weibull probability distribution LogNormalDistribution Generates samples from a Log Normal probability distribution LogLogisticsDistribution Generates samples from a Log Logistics probability distribution 9 2 User Defined Probability Distributions Users can define a distribution point by point if required A user defined distribution can be either a continuously varying value or one of a discrete set of values User Defined Probability Distributions Distribution Name Description Continuous Distribution Generates samples over a continuous range of values DiscreteDistribution Generates samples from a discrete set of values 9 3 Keywords
66. message will be displayed showing the cause of the error Depending on the object different keyword values will have different data types outlined in the following table Ausencs 2014 36 September 8 2014 JaamSim User Manual Input Data Types Data Type Description Numbers without units Specified with or without a decimal point e g 5 5 0 and 5 are equivalent entries A pre defined unit must be included e g 1000 mm 1 0 m and 0 001 km are Numbers with units equivalent entries Expressions Specified using object outputs and logical operators e g 1 2 Entity1 OutputB Booleans Indicated as either TRUE or FALSE case sensitive Fair Specified by a colour keyword or by an RGB value e g pink and 255 192 203 are equivalent entries The text must be enclosed in single quotes if it contains any spaces e g a b c Strings Note that abc and abc are equivalent entries Objects Specified by an object name For example View1 indicates the view window j View1 created automatically by JaamSim Object outputs Specified by an object name and an output name e g Queue1 QueueLength is the output named QueueLength for the queue object Queue1 The use of Expressions is described in the Advanced Topics section of this manual Curly braces are used to delineate distinct entries for keywords such as points e g 0 0 1 0 0 0 m 1 0 1 0 0 0 m A drop down menu is available for many types of inputs For a B
67. must be supplied for an OverlayText object Additionally instead of the Basic Graphics keywords common to other display objects overlay objects have the following keywords Key Inputs Keyword Description ScreenPosition A list of two numbers specifying the spacing in pixels between the left and top corner of the View window and the object va If TRUE the horizontal alignment is referenced to the right side of the view window AlignRight instead of the left If TRUE the vertical alignment is referenced to the bottom side of the view window AlignBottom instead of the top 7 4 BillboardText A BillboardText object is similar to a normal Text object except that the text is always oriented towards the view window and its height is given in pixels instead of metres BillboardText retains its coordinates in 3 space and in this way differs from the OverlayText object Both static and dynamic text can be dispayed by a BillboardText object using the same keywords as Text S Ausencs 2014 36 September 8 2014 JaamSim User Manual The keywords for BillboardText are identical to those for Text and have the same meaning except for the TextHeight keyword which now gives the height of the text in pixels instead of metres At the present time this input must include the units of metres m even though it is interpreted as pixels This deficiency will corrected in a future version of the software 7 5 Arrow An Arrow object consis
68. n January 11 0 24 km h On 2014 01 15 the first value of the list would be read again and the returned value from the TimeSeries would be 0 km h The TimeSeries would take on new values on January 17 and 25 and this 14 day cycle would repeat until the end of the simulation run 10 23 SignalThreshold The SignalThreshold object varies its state between open and closed when instructed to do so by one or more EntitySignal objects SignalThreshold has no internal logic of its own for changing state Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity Graphics Keyword Description OpenColour The colour to display when the SignalThreshold is open ClosedColour The colour to display when the SignalThreshold is closed ShowWhenOpen a the SignalThreshold is displayed when it it open If FALSE it is hidden en open ShowWhenClosed If TRUE the SignalThreshold is displayed when it it closed If FALSE it is hidden when closed 10 24 ExpressionThreshold The ExpressionThreshold object varies its state between open and closed depending on the value returned by an Expression The Expression to be evaluated is specified by the OpenCondition keyword It is re evaluated with every time advance of the model Default Graphic O Ausenc 2014 36 September 8 2014 JaamSim User Manual Key Inputs
69. n unpacked ProcessingRate The rate at which entities have been unpacked NumberProcessed Total Time 10 22 TimeSeries The TimeSeries object simulates a numerical value that varies with time Many JaamSim keywords are structured to accept a constant value a Probability Distribution or a Time Series which makes this object a powerful and flexible component of any simulation model The data for the object consists of a series of time stamps and values as specified by the Value keyword The time stamps can be irregularly spaced and it is possible to repeat the time series over and over again during the simulation using the CycleTime keyword The value returned by a TimeSeries object has a specific unit type specified by the UnitType keyword To maintain consistency the UnitType must be specified prior to any other unit Once specified it cannot be changed Default Graphic Key Inputs Keyword Description One of the pre defined unit types within JaamSim The list of valid UnitTypes can UnitType be found in the Object Selector under Units Once set this input cannot be changed by the user A series of timestamps along with the associated value for the TimeSeries at the Value given time The UnitType and must be specified before the Value keyword to ensure that the inputs pass validation CycleTime When the time series will repeat from the start By default the TimeSeries object will not cycle The format for timestamps follows th
70. ng on the DefaultT extModel object in the Object Selector and selecting Duplicate e Rename the new TextModel object by doubling clicking on the name in the Object Selector entering the new name and pressing Return key e Use the Input Editor to specify the characteristics for the new TextModel such as font italics bold colour etc e Use the Input Editor to select the new TextModel for the Text object s DisplayModel keyword A Text object for a specific graphical entity can be generated automatically by right clicking the object in a view window and selecting Add Label The Format keyword will be automatically populated with the name of the target entity and will have its RelativeEntity keyword set so that the label follows the target entity when it is moved The Text object has the following keywords in addition to those from DisplayEntity O 2014 36 28 A A September 8 2014 usenc 2014 36 September 8 2014 JaamSim User Manual Key Inputs Keyword Description The fixed and variable text to be displayed If spaces are included enclose the text in single quotes 1 If variable text is to be displayed using the OutputName keyword include the appropriate Java format in the text e g s will display a text output and 6f will display a number with six decimals of accuracy Format The output value chain that returns the variable text to be displayed If more than one output value is given all outputs but the last s
71. ns The output file is named lt configation file name gt lt EntityLogger name gt log to ensure that it is unique for the simulation run For example if the configuration file is named run1 cfg and the EntityLogger s name is EntityLogger1 then the name of the log file will be run1 EntityLogger1 log A pre existing file with this name will be overwritten once the simulation run is started Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity NextComponent The next object to which a received entity is passed Outputs Output Name Description obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time LogTime The simulation time at which the last entity was logged 10 4 EntityGenerator The EntityGenerator object creates a series of entities that are passed to the next object in a process The PrototypeEntity keyword identifies the entity to be copied This entity can be any type of object no matter how complex Copies retain both the graphics of the prototype as well as the values of all its inputs The rate at which entities are generated is determined by the InterArrivalTime and FirstArrivalTime keywords These inputs have units
72. nt Inputs that are pure numbers are indicated by the DimensionlessUnit type All Unit objects have the same keywords Keyword ConversionFactorToS PreferredUnit Key Inputs Description Two numbers that specify the numerator and denominator respectively of the multiplicative factor to convert from the new unit to SI base units The unit to be used in the Output Viewer for this unit type If no unit is entered the Output Viewer defaults to the SI unit The value entered for this keyword is shared between all the units for a given unit type 25 O Ausenc 2014 36 September 8 2014 JaamSim User Manual 6 1 Defining a New Unit In addition to the pre existing unit types defined in JaamSim the user can specify new units using a Unit object A new unit object can be created by right clicking on an existing unit and selecting duplicate After the unit is renamed appropriately its ConversionFactorToSl input can be set to the desired value For example to create a new TimeUnit for fortnight two weeks the ConversionFactorToSI keyword should be set to 1209600 1 Once this has been done keyword values in units of time will subsequently support the Fortnight unit when values are entered 6 2 Setting a Preferred Unit Model outputs are normally shown in the appropriate SI unit in the Output Viewer In many cases it is useful to show outputs in another unit For example it might be better to view a time
73. oolean input the user is offered a choice of TRUE or FALSE For an object input the user is offered a list of all the objects of the appropriate type Similar drop down menus are provided for most other types of inputs Colour Selection For readability it is often preferable to specify a colour input using a colour keyword instead of an RGB value e g pink instead of 255 192 203 A table of standard colour keywords is provided in the last section of this manual Alternatively the Input Editor provides a pop up menu containing a graphical palette shown in the figure below to aid colour selection The user can select a colour or adjust the RGB values via slider controls Colour Selection Pop up Window x 4 6 Output Viewer The Output Viewer displays the pre programmed outputs that are available for the selected object Output values are updated continuously as the simulation progresses Numerical outputs are displayed in SI units unless a Preferred Unit is specified In addition any user defined Attributes will also appear in Output Viewer z Ausencs 2014 36 September 8 2014 JaamSim User Manual The output system provided by JaamSim is the basis for all model graphics and reports An object can be animated by connecting a pre defined Action in its DisplayModel to one of its Outputs The figure below shows the outputs provided for a Queue object named Que Output Viewer Entity Name Que DisplayEntit
74. ord then the above rule is modified so that the LookAhead duration begins at the present time plus the offset Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity UnitType The Unit Type for the threshold e g DistanceUnit TimeUnit MassUnit TimeSeries The name of the TimeSeries object to be monitored MaxOpenLimit The limit over which the threshold is closed MinOpenLimit The limit under which the threshold is closed LookAhead The amount of time that the threshold must remain within MinOpenLimit and MaxOpenLimit to be considered open Offset The amount of time that the TimeSeriesThreshold adds to the present time for each TimeSeries lookup Ausencs 2014 36 September 8 2014 Keyword OpenColour ClosedColour ShowWhenOpen ShowWhenClosed 10 26 Statistics JaamSim User Manual Graphics Description The colour to display when the TimeSeriesThreshold is open The colour to display when the TimeSeriesThreshold is closed If TRUE the TimeSeries Threshold is displayed when it it open If FALSE it is hidden when open If TRUE the TimeSeries Threshold is displayed when it it closed If FALSE it is hidden when closed The Statistics object collects statistical information on the entities it receives The quantity to tracked is specified using the SampleValue keyword which accepts an Exp
75. oving along the line can pass one another due to their having different delay times The duration of each entity s delay is determined by the Duration keyword This input has units of time and can be a constant value a TimeSeries a Probability Distribution or an Expression Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity NextComponent The next object to which a received entity will be passed Duration The time required to process the incoming entity Points The coordinates for the start intermediate joints and end of the EntityDelay Width The with of the line representing the delay in pixels Colour The colour of the line representing the delay Outputs Output Name Description obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate 10 9 Assign The rate at which entities have been processed NumberProcessed Total Time The Assign object performs one or more Attribute assignments when it receives an incoming entity The Assign object is the only place where an attribute s value can be modified Attribute assignments can be performed for the Assign object itself the received entity or for any other entity in the model The received entity is passed to the next object without delay once the assignmen
76. put values of the selected object Property Viewer Detailed list of the internal properties of the selected object Log Viewer Console for viewing input wamings and error messages The Property Viewer is typically used by programmers who are developing and debugging JaamSim applications and so its usage is beyond the scope of this manual Views A View is a window showing a graphical 3D representation of the model The Views entry displays a menu containing a list of currently defined view windows and provides the ability to create new views Views Menu Entry Description Define new View Creates a new View object and displays its window Options Clicking on the Options entry in the menu bar generates a menu containing the following entries Options Menu Entry Description If checked the status bar displays the current position of the mouse cursor within Show Position the active view window Always On Top If checked the control panel will always remain on top of other windows If checked information on video memory usage and rendering time will be shown Graphic Debug Info as an overlay on the view windows Help Clicking on the Help entry in the menu bar displays a single menu option that shows the software version number and copyright information Tool Bar The Tool Bar contains controls for manipulating the simulation run and the 3D view for the active display window Run Controls O 2 Ausenc 2014 36 Septemb
77. puts Tab Keyword Value Key Inputs PrototypeEntity Proto Save the model and press Play to run the simulation Playing the Simulation File Tools Ausencs C 2014 36 September 8 2014 JaamSim User Manual Simulation Screenshot Viewi lolx Model Title 2014 Jan 01 00 00 20 406 Au senco The Real Time Factor controls how fast the simulated time elapses in the model The default Real Time Factor is 1 meaning each second watching the model corresponds to 1 simulated second and can be changed by using the arrows on the Real Time Factor or by entering a desired value Real Time Factor To continue working on the model either Pause the model which allows the simulation to later resume starting from the time Paused or Stop the model which resets the simulation 3 3 Step 3 Changing Model Graphics A few graphical adjustments will now be made to improve the appearance of the model While the changes in this step will not impact the functionality of the model graphics are invaluable when confirming proper operation in larger models Objects can be moved and resized by selecting them and holding down Control and left dragging If a handle is selected during this process the object will be resized otherwise it will move following the cursor These two techniques are illustrated using a cube in the figures below Ausencs C JaamSim User Manual Moving an Object
78. r inputs editable through the Input Editor Users can focus on the logic for their objects without having to program a user interface graphics input output processing or other model development tools Coding for new objects is done in Java using standard development tools such as Eclipse There is no need for the specialised simulation languages process flow diagrams or scripting languages used by commercial off the shelf simulation software Model logic can be coded directly in either an event or process oriented style using a few simple classes and methods provided by JaamSim JaamSim provides all the generic functionality needed for any simulation model Controls for launching and manipulating simulation runs Drag and drop user interface 3D interactive graphics Input and output processing Model development tools and editors It also provides palettes of basic objects that are used in typical simulation applications e Objects for process flow type models Text objects for labelling and documentation Graphs for visualizing simulation outputs Probability distributions for random sampling Graphical objects for background maps and logos e o o The only task left to the simulation programmer is to create additional palettes of high level objects needed for the specific application For example a highway simulation would require new objects for roadways vehicles traffic lights etc The new objects created in this way become exten
79. reating Model Objects e Step 2 Putting the Objects Together e Step 3 Changing Model Graphics e Step 4 Adding a Probability Distribution 3 1 Step 1 Creating Model Objects After launching JaamSim the following windows will appear Control Panel provides a number of run control features View Window displays a graphical representation of the model Model Builder offers a selection of objects that can be added to the model Object Selector lists the objects present in the model Input Editor allows for editing of keywords for a selected object 2014 36 4 September 8 2014 Object Sel IIS I Defined Objects ic Simulation Controls jb Units E Display Models i Graphics Objects ED View AA gt Veni usenco EB Overlaylmage EB Ee BEE BEE YL Probability Distributions Key Inputs Basic Graphics Output Value B Basic Objects Entity amp SimEntity Description Y EntityGenerator Simtime 8280105 u E Server Name Serv L u DisplayEntity I _ 6 Ji EntitySink NextComponent D ServToSink Position 0 507324 3 321153 0 0 m YL EntityConveyor Size 1 0 1 0 0 0 m Bb Queue alai E PA L orientation 0 0 0 0 0 0 rad 9 StateAssignment Alignment 0 0 0 0 0 0 ServiceTime 0 0 s 1 0 s Statetntity WaitQueue ServQueue State Working LinkedComponent obj Proto_Copy41 NumberAdded 41 0000 NumberProcessed 38 0000 IR 0 9552 Ausencs 2014 36 September 8 2014 JaamSim User Manual
80. received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The Release object de allocates one or more units of a specified Resource on receiving an incoming entity On release of one or more units of a Resource the Seize block with the entity that has waited the longest for the Resource is notified to process this entity Default Graphic Keyword Description AttributeDefinitionList NextComponent Resource NumberOfunits Output Name obj NumberAdded NumberProcessed ProcessingRate 10 13 Resource Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a received entity is passed The Resource to be released The number of units of the Resource to be released Outputs Description Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The Resource object provides a pool of units that can be seized and released by the Seize and Release objects Default Graphic Ss O j Ausenc September 8 2014 Keyword Description AttributeDefinitionList NextComponent Capacity Output Name UnitsSeized UnitsReleased UnitsInUse UnitsInUseAverage UnitsInUseStandardDeviation UnitsInUseMinimum UnitsInU
81. ression Some typical examples for this input are s this obj A the sample value is the attribute A carried by the received entity s this SimTime this obj t the sample value is the simulation time that has elapsed since the attribute t for the received entity was set to the simulation time at some earlier point in the model The TestEntity keyword should be set to the prototype for the entities received by the Statistics object This entity is needed to test whether the attributes used in the SampleValue expression actually exist Default Graphic Keyword Description TestEntity NextComponent SampleValue Output Name obj NumberAdded NumberProcessed ProcessingRate SampleMinimum SampleMaximum SampleAverage SampleStandardDeviation StandardDeviationOfTheMean Key Inputs Description Optional free form text that describes the object The prototype entity used to generate the entities received by the Statistics object The next object to which a received entity is passed An Expression that retums the sample value whose statistics are to be collected Outputs Description Entity last received by the Statistics object Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The smallest value that was observed The largest value that was observed The average of the values that were observed The standard deviation
82. s Ausenc 2014 36 September 8 2014 JaamSim User Manual JaamSim ignores extraneous whitespace allowing the object definition to span multiple lines provided that all objects are surrounded by braces Object instances can only be referenced after they have been defined Object Inputs Once an object is defined its keyword values can be set using a command of the following form lt object name gt lt keyword gt lt valuel gt lt value2 gt where value1 value2 is the list of values for the keyword separated by one or more spaces For instance the following line sets the colour of the Arrow object to be black Arrowl Colour black Multiple parameters for an object can be set in one line containing the object name followed by keyword and value pairs Arrowl Colour black Width 2 T Inner curly braces are used for keywords that accept multiple input values Arrowl Points 000m l111m Include Statements The user can store input data in multiple files and then refer to these files in an input configuration file using Include statements These statements refer to other input configuration files by filename and path surrounded by single quotes Include Base File InputFile cfg Include statements are particularly useful in studies where the analyst wishes to vary only a fewinputs across many simulation runs Using Include statements the analyst can create a base case configuration file and then
83. s idle The rate at which entities are processed is determined by the ServiceTime keyword This input has units of time and can be a constant value a TimeSeries a Probability Distribution or an Expression Default Graphic 8 Keyword Description AttributeDefinitionList NextComponent SeniceTime WaitQueue Output Name obj NumberAdded NumberProcessed ProcessingRate Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which the received entity is passed The time required to process the incoming entity A Queue object in which to hold entities that are waiting to be processed Outputs Description Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time S Ausencs 10 6 EntitySink JaamSim User Manual The EntitySink object destroys an incoming entity Default Graphic Keyword Description AttributeDefinitionList Output Name obj NumberAdded NumberProcessed ProcessingRate 10 7 EntityConveyor Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity Outputs Description Entity last received Number of entities received The total number of entities that have been processed The rate at which entities hav
84. seMaximum UnitsInUseDistribution 10 14 Branch JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a received entity is passed The number of units that can be seized Outputs Description The total number of units that have been seized to date The total number of units that have been released to date The present number of units that are in use The average number of units that have been in use to date The standard deviation of the number of units that are in use The fewest number of units that have been in use at any time The largest number of units that have been in use at any time A list of decimal values summing to 1 0 The first entry is the fraction of time that no units were in use The second entry is the fraction of time that one unit was in use and so on The number of entries is equal to the maximum number of units that have been in use at any time plus one The Branch object directs an incoming entity to a destination that is chosen from a list of alternatives The value for the Choice keyword determines the destination that is chosen 1 first branch 2 second branch etc The input to Choice can be a constant value a DiscreteDistribution a TimeSeries or an Expression The use of an Expression allows the choice to be made based on the attributes of the incoming entity Default Graphic
85. sions of JaamSim and automatically acquire the same features as the basic objects 1 2 Applications Ausenco s Transportation Logistics Simulator TLS is an example of an application module that extends JaamSim for a specific purpose TLS is designed to simulate mine to port and port to port supply chains so it includes a number of additional object palettes to JaamSim e Mine objects ore production trucks truck dumps storage stockpiles and silos etc e Railway objects trains tracks signals stations train loaders train unloaders etc e Material handling objects conveyors stacker reclaimers shiploaders surge silos etc e Marine shipping objects ships routes ports weather and ocean conditions tides etc Manuals for these packages are available to licensed users in separate publications Examples of models built using Ausenco s TLS can be found at http www youtube com javasimulation This document is separated into multiple stand alone chapters for easier reference 1 Introduction Ausencs JaamSim User Manual 2 Installing JaamSim 3 Getting Started JaamSim Basic Example 4 Graphical User Interface 5 Simulation Controls Palette 6 Units Palette 7 Graphics Objects Palette 8 Display Models Palette 9 Probability Distributions Palette 10 Basic Objects Palette 11 Advanced Topics 12 Colour Name Index with RGB Values 13 Basic Example Input Configuration File 2014 36 2 A Een September 8
86. that simply show the present state of the system such as the present length of a queue or the present position of an object are ignored Each output is printed on a separate line using the following formats e Output with units lt object name gt Output lt output name gt lt unit gt lt value gt e g Queue1 Output AverageQueueTime s 24 758558850846765 e Output without units lt object name gt Output lt output name gt lt value gt e g Queue Output NumberAdded 143 This format was chosen to make it easier to parse by a spreadsheet macro or a scripting language Typically selected outputs for a series of simulation runs are collected in a spreadsheet to form a summary table Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object A string containing the file path to the directory in which the output report is to be ReportDirectory printed If left blank the report is placed in the same directory as the configuration file InitializationDuration The length of the initialization period for the simulation run RunDuration The length of the simulation run Outputs Keyword Description None N A O u Ausenc 2014 36 September 8 2014 JaamSim User Manual 10 3 EntityLogger The EntityLogger object records the outputs attributes and state data for each entity that it receives The output log file is created automatically when the simulation run begi
87. these commands For example a batch file containing the following two lines would execute two runs runl cfg and run2 cfg JaamSim exe runl cfg b JaamSim exe run2 cfg b Note that the batch file and input configuration files must be in the same directory for this example to work 11 4 ScriptEntity The ScriptEntity object takes only one keyword which is the path to a script scr file s Ausencs 2014 36 September 8 2014 JaamSim User Manual Key Inputs Keyword Description Script Path to the file containing the scripting instructions to be loaded The script file contains sets of model configuration inputs preceded by the Time keyword belonging to the ScriptEntity object Originally developed for video capture a script can be used to change window views to create automatic zooming and panning and to turn on and off video capture during a run Furthermore keywords defined in the script file can be used to modify simulation and object parameters initially defined in the input configuration file Key Inputs for scr file Keyword Description Time The simulated time at which the subsequent inputs are executed Example The following inputs can be entered into a scr file and then referenced by a ScriptEntity object in order to slow down the model at a given point in the simulation run ScriptEntityl Time 24 0 h Simulation RealTime TRUE Simulation RealTimeFactor 1200 ScriptEntityl Time 30 0 h Simu
88. to this entity The amount of graphical space between entities in the EntityContainer Maximum number of entities contained in each row of the EntityContainer Outputs Description The present user defined activity being performed by the EntityContainer The Pack object is used to generate EntityContainers and fill them with incoming entities EntityContainers are created automatically on demand by the Pack object The number of entities to be packed in each EntityContainer is determined by the NumberOfEntities keyword Once the specified number of entities are available in the Queue they are packed one by one in the EntityContainer in same order as the Queue The time to pack each entity is specified by the ServiceTime keyword Default Graphic 3 O Ausenc Keyword Description AttributeDefinitionList NextComponent Operating ThresholdList PrototypeEntityContainer WaitQueue NumberOfEntities SeniceTime Output Name obj NumberAdded NumberProcessed ProcessingRate 10 21 Unpack JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which a packed EntityContainers is passed A list of Threshold objects which must be open for the packing operation to proceed The EntityContainer whose copies will be packed The Queue in which the arriving entities are stored while they wait to be packed
89. to wall clock time Minutes of wall clock time remaining until the simulation is completed Location of the mouse cursor in the active view window expressed in x y Z coordinates View windows similar to the figure below display a graphical representation of a simulation Multiple view windows can be defined depicting different parts of a model Each view window is an instance of a View object and can be modified interactively O 2 Ausenc 2014 36 September 8 2014 JaamSim User Manual View Window with Default Graphical Entities O xd Model Title a rs Default Objects When a new model is created a default view window shown in the above figure is created with some default graphical objects that appear in this window XY Grid XYZ Axis AusLogo Title and Clock The XY Grid and XYZ Axis objects are intended as visual aids for placing new objects and as such they are regular static graphics DisplayEntity objects The Movable keyword is set to FALSE for both objects so that they cannot be moved accidentally and do not respond to mouse clicks The other three objects are the Ausenco wordmark a place holder title for the model and calendar and clock to show simulation time These objects are Overlay Objects Overlaylmage OverlayText and OverlayClock respectively that appear in a fixed position on the view window and are not part of the 3D scene The position and format of the default ob
90. tory such as the directory containing the model input files Launch JaamSim by double clicking on the executable file TLS and other JaamSim based applications are stand alone executable files and are installed in the same way The executable file for example TLS exe for the Transportation Logistics Simulator can be copied directly to the folder containing the model run files and launched directly from there or by a shortcut It is not necessary to install JaamSim in addition to the application specific executable O E Ausenc JaamSim User Manual 3 Getting Started JaamSim Basic Example Welcome to JaamSim In this example users will be guided through building a basic model using the graphical user interface GUI that simulates entities being generated processed and consumed The finished model should look similar to the model below Finished JaamSim Basic Example _J2amsim JaamSimBasickxample LT Fie Tools Views Options Help O mae Re Ta View Control Perspective XY Plane BSE Simulation Time hrs 0 02 0 Speed Up 2 Time Remaining mins 1313 Pos 6 720 1 393 0 000 rode nun BY ven 85 Hra Model Title Y L Probability Distributions Y L Basic Objects Y Calculation Objects Y L Fluid Objects Q amp eee This example will be divided into four steps s Step 1 C
91. ts have been performed The attribute assignment to be performed are specified by the AttributeAssignmentList keyword Examples of the inputs to this keyword are 2014 36 45 September 8 2014 Ausencs JaamSim User Manual e this A this A 1 e this obj B this obj B 1 e Entity1 C Entity1 c T In this example the entries A B and C are the attributes of the Assign object the entity received and Entity1 respectively The right hand side of each assignment equation is an Expression to be evaluated The left hand side identifies the attribute whose value is to be modified The attribute is named using the same conventions as an expression Note that only attributes can be assigned it is not possible to assign a new value to an output Outputs can only appear in the expression on the right hand side of assignment equation The Unit Type for the Expression must match the Unit Type for the Attribute that was defined as part of the input to the AttributeDefinitionList keyword Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity NextComponent The next object to which the received entity is passed AttributeAssignmentList The assignment equations to be performed on receipt of an entity Outputs Output Name Description obj Entity last received NumberAdded Number of entities receive
92. ts of a line possibly multiple line segments and an arrowhead It can be used to point out objects in a view window In addition to the Basic Graphics keywords the table below describes keywords used for this object in particular Key Inputs Keyword Description Points A list of points in x y Z coordinates defining the line segments that make up the arrow When two coordinates are given it is assumed that z 0 A set of x y z numbers that define the size of the arrowhead in those ArrowSize carn directions at the end of the connector Width The width of the arrow line segments in pixels Colour The colour of the arrow defined using a colour keyword or RGB values Arrows and other graphical objects that use the Points keyword ignore the Position Alignment and Orientation keywords since their placement is defined completely by their Points coordinates 7 6 Graph The Graph object is a real time visual representation of one or more output values displaying its current value in the context of its recent history The figure below shows an example of a graph with keywords related to formatting its appearance labelled directly on the graph The formatting is applied by specifying a GraphModel object to the DisplayModel keyword Sample Graph with Formatting Keywords Defined Graphically i j Background YAxisLabelGap TopMargin Title d rn ritiecap 10 2 aph S E Ge YAxisLines x 2 2 2 Line gt 6 t 8 Z
93. und colour for parts of the video frame not covered by a view window The number of frames to capture The amount of simulated time elapsed between captured frames If TRUE individual screen captures are made for each frame and output to image files If TRUE video capture is enabled and an AVI file is output by the video recorder The size of the rendered image or video in pixels A list of views to include in the video or image The name of the video output file O S Ausenc JaamSim User Manual 12 Colour Name Index with RGB Values Colour Name Colour R G B Colour Name Colour R G B lavenderblush 255 240 245 chocolate E 20 165 30 pink 255 192 203 rawsienna BE y 2x lightpink 255 182 193 sienna E o 2 palevioletred D 219 112 147 brown Ws s 19 hotpink 235 105 180 lightsalmon a 1600 122 deeppink 5 2 147 darksalmon ee 223 150 122 violetred DO 28 32 1m salmon 250128114 mediumvioletred DP 199 2 133 lightcoral 2 18 128 raspberry eis xs 37 coral 25 m 86 thistle 216 191 216 tomato DO a ww 7 plum 221 160 221 orangered DP 2 2 orchid fe 218 112 214 red s o 0 Violet fee 238 130 238 crimson DW o 2 magenta Mee 255 o 255 firebrick ew 34 purple B s o 128 indianred B o 3 3 mediumorchid D 186 a2 bumtumber B 5 30 darkorchid E 155 50 20 maroon Mi 0o o darkviolet Ws o 2 sepia 9 a 3 1s blueviolet 35 4 2s white 255 255 255 indigo E 5 o 130 gray99 252 252 252 mediumpurple ar 112
94. uration Allows the model to reach steady state before statistics are recorded The total length of the simulation run is the sum of InitializationDuration and RunDuration The number of discrete time steps in one hour e g a value of 3600000 means that the smallest time step is one millisecond If TRUE an input report is generated once the simulation is loaded The report can otherwise be generated from the File menu A numerical multiplier that defines how quickly with respect to wall clock time the simulation runs If TRUE then the simulation runtime is held constant at a multiple of real time If FALSE then the simulation runs as fast as possible and may vary throughout the run If TRUE JaamSim will close all windows and exit when the simulation run is finished If TRUE the Model Builder will be displayed when the input file is loaded If TRUE the Object Selector will be displayed when the input file is loaded If TRUE the Input Editor will be displayed when the input file is loaded If TRUE the Output Viewer will be displayed when the input file is loaded If TRUE the Property Viewer will be displayed when the input file is loaded If TRUE the Log Viewer will be displayed when the input file is loaded O 2 Ausenc 2014 36 September 8 2014 JaamSim User Manual 6 Units Palette JaamSim performs all internal calculations in SI units meters kilograms seconds etc However many quantities employed
95. y Position 0 493151 2 431863 0 0 m Size 0 431764 0 365344 0 0 m Orientation 0 0 0 0 0 0 rad Alignment 0 0 0 0 0 0 Queue QueueLength NumberAdded QueueLengthMinimum QueueLengthMaximum NumberRemoved 5 QueueLengthAverage 0 0900710 QueueLengthStandardDeviation 0 286283 QueueLengthDistribution 909929031696273 09007096830372699 6 S Ausencs C 2014 36 September 8 2014 JaamSim User Manual 5 Simulation Controls Palette The Simulation object named Simulation is used to store inputs used to define basic parameters of the model such as run duration Unlike other objects the Simulation object is created automatically when a new model is started It does need to be dragged and dropped by the user and for this reason it does not appear in the Model Builder List of objects e Simulation 5 1 Simulation As with other objects the simulation parameters are changed using the Input Editor Keyword RunDuration InitializationDuration SimulationTimeScale PrintInputReport RealTimeFactor RealTime ExitAtStop ShowModelBuilder ShowObjectSelector ShowlnputEditor ShowOutputViewer ShowPropertyViewer ShowLogViewer Key Inputs Description Duration of the simulation run in which statistics will be recorded Duration of the initialization period from which the run statistics are discarded before the simulation is run for the time specified in RunD

JaamSim Manual (full)

Contents

Download Pdf Manuals

Related Search

Related Contents