VeriStand .NET API Reference

Model Members

The Model type exposes the following members.

NameDescription
Model
Overloaded. Initializes a new instance of Model and sets the network port that an .mdl file uses for communication via TCP. DLLs and .lvmodel files do not require a network port.

Methods

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.)
GetExecutionSection Gets the Execution section, which contains channels that track execution details of the model, such as its current status and the amount of time that has elapsed since it began executing. .
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetInportsSection Gets the Inports section, which contains all the Inport and InportGroup objects under the model.
GetOutportsSection Gets the Outports section, which contains all the Outport and OutportGroup objects under the model.
GetParametersSection Gets the ModelParameters section, which contains all the ModelParameter and ModelParameterGroup objects under the model.
GetParent Gets the parent node of this node. (Inherited from BaseNode.)
GetSignalsSection Gets the ModelSignals section, which contains all the ModelSignal and ModelSignalGroup objects under the model.
GetTypeGets the Type of the current instance. (Inherited from Object.)
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
RefreshModelInformation
Overloaded. Reloads a previously imported model.
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. (Overrides BaseNode.RenameNode(String).)
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
BaseNodeType Gets a reference to the internal representation of this node. (Inherited from BaseNode.)
BaseRate Gets the base rate of the model in microseconds.
Decimation Gets or sets the decimation applied to the Primary Control Loop rate to determine the BaseRate of the model.
Description Gets or sets the description of this node. (Inherited from BaseNode.)
DLLPath Gets a reference to the compiled version of the model (.dll file).
DLLSize Gets the size, in bytes, of the compiled version of the model (.dll file).
DLLTimestamp Gets the time at which the model DLL was compiled.
GlobalParameterScope Gets or sets whether global parameters in the current model share their values with other models on the same target.
LoadSuccess Gets whether NI VeriStand loaded the model successfully.
MD5 Gets the MD5 message-digest for the model.
ModelPath Gets a reference to the uncompiled model file.
ModelTimestamp Gets the time at which the model was last saved.
Name Gets the name of this node. To rename a node, use the RenameNode method. (Inherited from BaseNode.)
NIVeriStandServerPort Gets or sets the network port that the model uses for communication via TCP. This property only applies to uncompiled models from The MathWorks, Inc. Simulink® software. DLLs and .lvmodel files do not require a network port.
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.)
Processor Gets or sets the processor on which the Model Execution Loop executes. -2 automatically assigns the processor to "any available".
SegmentVectors Gets information about whether or not vector inputs, outputs, parameters, and signals were split up into scalar channels when the model was loaded.
ShowUnnamedSignals Gets whether signals without names are visible.
TypeGUID Gets the GUID associated with the node. Attempts to set the GUID of a BaseNode will generate an exception. (Inherited from BaseNode.)
UserRate Obsolete.

THIS PROPERTY IS OBSOLETE in NI VeriStand 2011 SP1 and later. Use BaseRate instead.

Gets the user rate of the model.

See Also

Log in to get a better experience