String Holder Block :: SAS(R) Simulation Studio 14.1: User's Guide

Description

The String Holder block displays a string that represents state information that you define. Values can be pushed to or pulled from a String Holder block via its InData and OutData ports. The String Holder block displays the last value to enter through its InData port and automatically attempts to push any value that is received at its InData port out its OutData port. Similarly, when a request comes in to pull a value from the OutData port, a String Holder block, by default, attempts to pull a value from upstream using its InData port. You can use the Propagation controls on a String Holder block to modify this default behavior.

The data collection facility of the String Holder block enables you to store values that enter the block. Data can be saved to a SAS data set or JMP table. Values (along with timestamps) are stored in a data model object, and the data model object can be accessed through the block’s OutCollected port. Any block that uses a data model object is automatically notified when the data in the data model object are modified.

When a true Boolean value arrives at the InClearData port, it is used as a signal to clear all the data collected by the String Holder block up to that time during the simulation execution. If the InClearData port receives a false value, the signal is ignored and data are not cleared.

Fixed Ports

InData: Input string port for the value to be held by the String Holder block.
InClearData: Input Boolean port that is used to clear all data collected by the String Holder block.
OutData: Output string port for the value currently held by the String Holder block.
OutCollected: Output port for the data model object representing the data that have been collected by the String Holder block.

Properties Dialog Box Controls

Current: Displays the last value to enter the String Holder block. The value entered here is displayed in the block until a new value enters the block.
Default: Specifies the current value for the String Holder block when the block is initialized.
Propagation: The To Downstream check box controls propagation of values sent to the InData port of a String Holder block. If this check box is selected, any values that enter the InData port are automatically sent out the OutData port. Otherwise, the value propagation stops at the String Holder block. If the From Upstream check box is selected, any attempt to pull a value from the OutData port of a String Holder block results in the String Holder block attempting to pull a value from one or more blocks that are connected to its InData port.
Data Collection: The Collect Data check box turns data collection on or off. The value entered in the Capacity field determines how many values are saved in the data model object. If the capacity is exceeded, a warning message is logged and values are overwritten in the data model object.

Save Dialog Box Controls

Automatic Save: Turns on or off automatic saving of any collected data at the end of each design point replication run. If automatic saving is turned on, data are saved to a file with the base filename that is specified in the Base File Name field. Simulation Studio automatically determines the pathname of the folder for this file based on the pathname of the folder that contains your saved project. If the Submit to Remote SAS Workspace Server option is selected, then any collected data are saved to a file on a remote SAS server. Simulation Studio automatically determines the pathname of the folder for this file on the remote SAS server by using the Default File Path specified in the Simulation Studio Configuration dialog box.
Save Now: Forces the String Holder block to attempt an immediate save of any collected data. Data are saved to the same location as when automatic saving is turned on.
Location: Displays the pathname of the folder for the file in which to save any collected data.
Base File Name: Specifies the base filename for the SAS data set or JMP table that is used to save any collected data. This name will be the prefix of the actual filename. The zero-based index of the design point and the zero-based index of the replication number will be added as suffixes to the file name, separated by underscore characters. For example, the data for the first replication of the first design point will be saved in a file named BaseFileName_0_0, and the data for the second replication of the first design point will be saved in a file named BaseFileName_0_1.

Candidates for Design of Experiments

Factors: DefaultValue (string)
Responses: Value (string)

Templates