VeriStand .NET API Reference

Stimulus Members

The Stimulus type exposes the following members.

NameDescription
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Class Destructor (Overrides Section.Finalize().)
FindChildrenByGUID Gets an array that contains the child BaseNode elements of the current node that match the specified TypeGUID. (Inherited from BaseNode.)
FindFirstChildWithName Gets the first child node with the specified name. (Inherited from BaseNode.)
FindNodeByPath Gets a node using the specified path. (Inherited from BaseNode.)
GetChildren Gets an array that contains the child BaseNode elements of the current node. (Inherited from BaseNode.)
GetDocumentPath Gets the path to the system definition file that owns this node. (Inherited from BaseNode.)
GetDocumentRoot Gets the Root node of the system definition file. (Inherited from BaseNode.)
GetGeneratorList Gets an array that contains the Generator elements from the Stimulus section. This method gets a list of existing stimulus generators in the system definition.
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetParent Gets the parent node of this node. (Inherited from BaseNode.)
GetTypeGets the Type of the current instance. (Inherited from Object.)
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
RemoveNode Removes this node from the hierarchy, if the node can be removed. (Inherited from BaseNode.)
RenameNode Renames this node to the name you specify, if the node can be renamed and if the name you specify is not already in use by a sibling of this node. (Inherited from BaseNode.)
SetGeneratorCount Sets the number of stimulus generators in the system.
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
AnalysisBufferSize Gets or sets the size of the analysis buffer. The analysis buffer stores the expected result values for a table test. Set this value to a number that matches or exceeds the number of expected result values in a given table test.
AnalysisResultSize Gets or sets the size of the analysis failure result buffer. The analysis failure result buffer stores the failure results for a table test. Set this value to a number that meets or exceeds the maximum number of failures you expect to occur in the table test.
AuxilliaryBufferSize Gets or sets the size of the auxiliary buffer. The auxiliary buffer stores multi-point playback data in comma-separated value (CSV), files. Set this buffer size to a number that matches or exceeds the number of data points in the CSV file you want to play back. The auxiliary buffer size is shared by all active stimulus generators, so all generators can have up to Auxiliary Buffer Size total in data points for playback.
BaseNodeType Gets a reference to the internal representation of this node. (Inherited from BaseNode.)
Description Gets or sets the description of this node. (Inherited from BaseNode.)
MaxGenMaps Gets or sets the maximum number of stimulus generator mappings across the entire system.
MaxSteps Gets or sets the maximum number of steps a stimulus generator can contain. Set this value to a number that is larger than the number of steps in the longest generator script.
Name Gets the name of this node. To rename a node, use the RenameNode method. (Inherited from BaseNode.)
NodeID Gets the ID of this node. (Inherited from BaseNode.)
NodePath Gets the path to the node within the system definition file. (Inherited from BaseNode.)
TypeGUID Gets the GUID associated with the node. Attempts to set the GUID of a BaseNode will generate an exception. (Inherited from BaseNode.)

See Also

Log in to get a better experience