SaveAsTclWithXmlCommand Object


Description:

Saves the current configuration as a configuration XML file and a Tcl script that loads the XML configuration file.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

SaveAsTclWithXmlCommand Writable Attributes

Attribute Description
Common Writable Attributes Active, Name, ProgressCancelled
BeforeDisconnectScript

An optional Tcl script to run with the generated script before disconnecting from the Spirent TestCenter chassis.

Type: string

Default: "" (empty string)

Config

Handle of the portion of the configuration to save. The default of 1 means system1, which is the root object of the entire configuration.

Type: handle

Default: 1

FileName

File name to use for the script.

Type: outputFilePath

Default: config.tcl

PathReplacements

Path to replace system file path for output files.

Type: string

Default: "" (empty string)

ProcedurePrefix

A prefix to add to the generated Tcl procedure names to ensure uniqueness. This can be a namespace like abc:: (abc::procedurename) or a simple text prefix (abcprocedurename).

Type: string

Default: "" (empty string)

SaveDefault

When this is selected (the default), only objects and attributes that are changed from their default settings will be included in the script. This can make the script much more compact and easier to read. It does not change the way the script functions.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Include only objects and attributes with changed defaults.

FALSE

Include all objects and attributes.

TclNamespace

Namespace for procs and global variables for Tcl script.

Type: string

Default: "" (empty string)

SaveAsTclWithXmlCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status