VeriStand .NET API Reference

StimulusProfile Members

The StimulusProfile type exposes the following members.

NameDescription
StimulusProfile
Overloaded. Initializes a new instance of StimulusProfile.

Methods

NameDescription
Abort Immediately terminates the execution of the stimulus profile, without executing any clean up-tasks.
CheckForErrors Performs checks on the stimulus profile and returns any errors, warnings, or messages that are relevant to the stimulus profile's current configuration.
Clone Creates a new object that is a copy of the current instance. (Inherited from BaseNode.)
Continue Continues the execution of the stimulus profile if it was previously paused.
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
ExecuteAsync Starts executing the stimulus profile asynchronously, or in a separate VeriStand Engine loop from the Primary Control Loop.
FinalizeAllows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetTypeGets the Type of the current instance. (Inherited from Object.)
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Pause Pauses the execution of the stimulus profile.
SaveStimulusProfile Saves the stimulus profile file with the name and to the location specified by file.
Stop Stops the execution of the stimulus profile. Stopping execution causes the stimulus profile to jump to and execute the tasks in the CleanupStepGroup before terminating execution.
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
CleanUp Gets or sets the CleanupStepGroup for the stimulus profile, which contains the finalization section of stimulus profile code.
Description Gets or sets the description of the node that appears in the Property Browser when you select the node in the Stimulus Profile Editor. (Inherited from BaseNode.)
FileFormatVersion Gets or sets the file format version of the real-time sequence definition file. (Inherited from RootNode.)
FileName Gets the name of the real-time sequence definition file on disk. (Inherited from RootNode.)
FilePath Gets the full path on disk to the real-time system definition file. Setting this property updates the value of FileName. (Inherited from RootNode.)
Main Gets or sets the MainStepGroup for the stimulus profile, which contains the main execution code of the stimulus profile.
ResultsDirectory Gets the path to the folder on disk where test result data is stored. When a stimulus profile finishes executing, NI VeriStand generates an XML file with the results of the test and saves it in this folder. The file adheres to the Automatic Test Markup Language (ATML) standard.
ResXKey Gets or sets the ResX key for the node, which is a pointer to a .resx file that contains a context help description for the node. (Inherited from BaseNode.)
Setup Gets or sets the SetupStepGroup for the stimulus profile, which contains the initialization section of stimulus profile code.
State Gets the execution state of a step (Idle, Initializing, Running, and so on.)
StopExecutionOnFail Gets or sets whether execution of the stimulus profile stops if a step fails. Stopping execution causes the stimulus profile to jump to and execute the tasks in the CleanupStepGroup before terminating execution.
Version Gets or sets the version of the real-time sequence definition file. (Inherited from RootNode.)

Events

NameDescription
ExecuteCompleted Occurs when the stimulus profile completes execution.
ProgressChanged Occurs when the progress of the stimulus profile execution changes, such as when a new step begins executing.
PropertyChanged Occurs when a property value changes. (Inherited from BaseNode.)

See Also

Log in to get a better experience