TestResultSetting Object

Description:

Configure output file paths and get other information. The paths you define with this object control most of what is returned by GetTestResultSettingPathsCommand.

Writable Attributes
Read-Only Attributes

Automatically created from: Project

TestResultSetting Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

ResultsDirectory

Directory to save results in. This is appended to what is set for SaveResultsRelativeTo. To make a fully-qualified (absolute) path, enter it here and set SaveResultsRelativeTo to NONE.

Type: string

Default: "" (empty string)

SaveOutputFilesInCwd

It is recommended that you leave this at the default setting. It is used to restore "legacy" file saving behavior (previous to Spirent TestCenter version 3.00) for output files that use relative paths.

NOTE: Absolute file paths are not affected by the setting of this attribute.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Files that use relative paths will be saved in the current working directory (legacy behavior). The ResultsDirectory and SaveResultsRelativeTo attributes will have no effect.
FALSE	Files that use relative paths will be saved according to the settings of the ResultsDirectory and SaveResultsRelativeTo attributes of this object.

SaveResultsRelativeTo

Base directory for saving results. If you specify a directory with the ResultsDirectory attribute, it is appended to this.

Type: enum

Default: CURRENT_WORKING_DIR

Possible Values:

Value	Description
INSTALL_DIR	Spirent TestCenter installation directory.
CURRENT_WORKING_DIR	Current working directory. This is the directory that Spirent TestCenter currently has open.
USER_WORKING_DIR	User working directory. Usual value on non-Vista Windows: C:/Documents and Settings/<username>/My Documents/Spirent/TestCenter <version>/ Where <username> is your Windows user ID and <version> is the Spirent TestCenter version number. Usual value on Windows Vista: C:/Users/<username>/Documents/Spirent/TestCenter <version>/ Usual value on Linux and Solaris: ~/Spirent/TestCenter <version>/
CURRENT_CONFIG_DIR	Current configuration directory. This is the directory where the saved or loaded .xml or .tcc file is. If no .xml or .tcc file has been saved or loaded, files are saved to the user working directory.
NONE	No base directory specified. If you want to specify an absolute path, use this NONE value and set the ResultsDirectory attribute to the absolute path.

TestResultSetting Read-Only Attributes

Read-Only Attribute

Description

ConfigTimestamp

Timestamp associated with the last command sequencer execution of the current configuration. This timestamp is used to name the main results folder that is used to store results databases and output files associated with the current configuration.

Type: string

Default: "" (empty string)

CurrentJsonResultFileName

JSON result file name.

Type: string

Default: "" (empty string)

CurrentResultFileName

Mainly for internal Spirent TestCenter use. When a results database is written, this attribute contains the name of the active results database.

Type: string

Default: "" (empty string)

CurrentResultState

Mainly for internal Spirent TestCenter use. This is updated when commands are running and writing to a database file.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	No state.
TEST_START	Start of test.
TEST_END	End of test.
ITERATION_START	Start of a test iteration.
ITERATION_END	End of a test iteration.