Statistics

The Statistics object collects statistical information on the entities it receives.

The quantity to be tracked is specified using the SampleValue keyword, which accepts an Expression.  Some example inputs are:

·         'this.obj.A' - the sample value is the Attribute ‘A’ carried by the received entity

·         '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 Statistics object can also aggregate the state statistics for the arriving entities using the RecordEntityStateTimes keyword.

Statistics Inputs

Keyword

Description

Key Inputs

 

Description

A free-form string describing the object.

NextComponent

The next object to which the processed entity is passed.

UnitType

The unit type for the variable whose statistics will be collected.

SampleValue

The variable for which statistics will be collected.

HistogramBinWidth

Width of the histogram bins into which the recorded values are placed. Histogram data will not be generated if the input is left blank.

RecordEntityStateTimes

If TRUE, the state times for received entities are recorded for statistics generation.

ResetEntityStateTimes

If TRUE, the state times for received entities are set to zero on departure.

Options

 

AttributeDefinitionList, CustomOutputList

See Section 6.2.

Graphics

 

Position, Alignment, Size, Orientation, Region, RelativeEntity, DisplayModel, Show, Movable, VisibleViews, DrawRange

See Section 11.1.

Statistics Outputs

Output Name

Description

Entity and DisplayEntity

 

Name, ObjectType, SimTime, Parent, Attributes, Custom Outputs, Position, Size, Orientation, Alignment, GraphicalLength, ObserverList, NextList, PreviousList

See Section 10.1.

StateEntity

 

State, WorkingState, WorkingTime, StateTimes, TotalTime

See Section 10.3.

LinkedComponent

 

obj, NumberAdded, NumberProcessed, NumberInProgress, ProcessingRate, ReleaseTime

See Section 16.

Statistics

 

SampleMinimum

The smallest value that was recorded.

SampleMaximum

The largest value that was recorded.

SampleAverage

The average of the values that were recorded.

SampleStandardDeviation

The standard deviation of the values that were recorded.

StandardDeviationOfTheMean

The estimated standard deviation of the sample mean.

TimeAverage

The average of the values recorded, weighted by the duration of each value.

TimeStandardDeviation

The standard deviation of the values recorded, weighted by the duration of each value.