EntityLogger

The EntityLogger object records the outputs, attributes, and state data for each entity that it receives.

The TraceEntityStates input provides an alternative mode of operation.  When this input is set to TRUE, the entities received by the EntityLogger are instructed to record a log entry each time they change state.

The output log file is created automatically when the simulation run begins.  The output file is named <configuration file name>-<EntityLogger name>.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.

EntityLogger Inputs

Keyword

Description

Key Inputs

 

Description

A free-form string describing the object.

DataSource

One or more sources of data to be logged.  Each source is specified by an Expression.  It is best to include only dimensionless quantities and non-numeric outputs in the DataSource input.  An output with dimensions can be made non-dimensional by dividing it by 1 in the desired unit, e.g. '[Queue1].AverageQueueTime / 1[h]' is the average queue time in hours.  A dimensional number will be displayed along with its unit.  The 'format' function can be used if a fixed number of decimal places is required.

IncludeInitialization

If TRUE, entries are logged during the initialization period.

StartTime

The time at which the log starts recording entries.

EndTime

The time at which the log stops recording entries.

NextComponent

The next object to which the processed entity is passed.

TraceEntityStates

If TRUE, an entry will made in the log file every time one of the received entities changes state.

Options

 

Active

If TRUE, the object is used in the simulation run.

AttributeDefinitionList, CustomOutputList

See Section 6.2.

Graphics

 

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

See Section 11.1.

EntityLogger Outputs

Output Name

Description

Entity and DisplayEntity

 

Name, ObjectType, SimTime, Parent, Position, Size, Orientation, Alignment, GraphicalLength, ObserverList, NextList, PreviousList, EntityReferenceList

See Section 11.1.

Logger

 

LogTime

The simulation time at which the last log entry was made.

EntityLogger

 

obj

The entity that was received most recently.

User-defined attributes and custom outputs

As defined by the AttributeDefinitionList and CustomOutputList inputs.