VdpInstanceInfoCommand Object


Description:

Retrieves detailed VSI instance information for the devices in the HandleList.

Can be used with Command Sequencer: Yes

GUI Command Name: VEPA: Save VSI Instance Info

Parents: Project, Sequencer, StcSystem

VdpInstanceInfoCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
FileName

Name of the file in which to save the VSI instance information.

Type: outputFilePath

Default: vsi_instances.csv

HandleList

List of VdpStationConfig or VsiBlockConfig handles.

Type: handle

Default: 0

SaveToFile

Enable saving of the VSI instance information into a file.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Save the VSI instance information into a file.

FALSE

Do not save the VSI instance information into a file.

TimestampFilename

Whether to include a timestamp as part of the filename.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include a timestamp as part of the filename.

FALSE

Do not include a timestamp as part of the filename.

VdpInstanceInfoCommand Read-Only Attributes

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