Description

The Probe block is used to pull and store other block state information values at specified time intervals. Attributes to be pulled from other blocks are named in the Probe block’s Attributes Table. The names are arbitrary but must be unique within each Probe block. When values are pulled from other block ports, the values are stored in a SimDataModel. The SimDataModel can be accessed through the block’s OutData port. Display blocks, such as the Histogram block, are often connected to a Probe block’s OutData port to visualize the data. Any block using a SimDataModel is automatically notified when the data in the SimDataModel is modified.

The user creates attributes entries in the Probe block’s Attributes Table by selecting the Add button on the Properties Dialog Attributes page. This results in a new attribute entry (with a default name and type) being added to the Attributes Table. The Name and Type of the attribute can be edited directly in the table. The attribute names listed in the Probe block’s Attributes Table must be unique. The attribute type can be changed through a drop-down box on the Type table cell. Attributes can be deleted from the Attributes Table by selecting the attribute row in the table and then selecting the Remove button. Selecting the Apply button causes all entries in the Attributes Table to be pushed to the Probe block and any input value ports are created or deleted as needed.

Each attribute in the Probe block’s Attributes Table has an input value port associated with it. At the specified time interval the Probe block will attempt to pull values from each of its attribute input ports and store those values in its SimDataModel instance. The frequency with which the Probe block will pull values is controlled through its Poll Interval options. The user can decide to pull at a constant interval by selecting the Constant radio button and entering a valid value in the Interval field. Another option is to have the Probe block pull a value from its InPollInterval port to determine when the next attributes pull should be scheduled. In this case the user must select the Port option and attach a valid numeric source (such as a Numeric Source block) to the InPollInterval port.

The user can limit the number of observations stored in a Probe block through its Capacity control. If the capacity is exceeded, a warning will be logged and observations will be overwritten.

The Probe block provides the capability of saving values it extracts to a SAS data set or JMP table. Saving options are available on the Save Dialog.

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

Dialog Controls

Add

Adds a new attribute to the Attributes Table.

Remove

Deletes an attribute that has been selected from the Attributes Table.

Capacity

This field is used to control how many observations the Bucket block will store.

Poll Interval

Selecting the Constant radio button and entering a valid value in the Interval field causes the Probe block to pull at a constant time interval. Selecting the Port radio button will cause the Probe block to pull a value from the InPollInterval port to determine its next sampling time.

Save Dialog 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 file name 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 containing 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 Probe 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 file name 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 file name. 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

Capacity (integer), PollingInterval (double)

Responses

None