GPS-X Technical Reference

Tools Object 336
CHAPTER 12
Tools Object
This chapter discusses the models found in the Tools object. Each model is listed in separate
sections below.
DATA TRANSFER
SAMPLER
The datatransfer model is used for transferring data between GPS-X data files and ACSL. When
data is read from GPS-X's .dat files, it can only be displayed on graphs or controllers. With the
datatran model, this data is sent to a data array and therefore is available for processing by
ACSL commands (e.g. through the Command: line in the Simulation Control window).
The data transfer parameters are accessed by selecting Parameters > Set up in the Process Data
menu. These parameters are detailed below:
Data variable name: This is the cryptic name of the data variable found in the .dat file.
Data transfer (ON – OFF): This switch activates the data transfer.
The sampler model will sample any stream either at regular time intervals (i.e., take a sample
every `x' hours) or in proportion to the flow rate of that stream (take a sample every `x' m 3 of
flow). It reports either daily or total simulation run average values.
The sampling tool parameters are accessed by selecting Parameters > Set up in the Process Data
menu. These parameters are detailed below:
Label of sample stream: This is the label of the stream being sampled. All of the state
and composite variables in this stream are sampled.
Sampling mode ( Off / Flow Proportional / Regular Time Intervals ): This switch
controls how the stream is sampled. The stream can be sampled in proportion to the flow
or at regular time intervals.
Sampling period ( Daily / Total Run ): This is the time period used when calculating
the averages of the sampled values. The averages can be calculated on a daily basis or for
the entire run.
GPS-X Technical Reference