VeriStand .NET API Reference

Table of Contents

CANPort Members

The CANPort type exposes the following members.

NameDescription
CANPort Initializes a new instance of the CANPort class and creates a port with the specified Name, PortNumber, LinkedDatabase, ClusterName, and BaudRate.

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.)
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetIncoming Gets the Incoming section of the current CANPort, which includes incoming single-point frames and raw frame data logging files.
GetOutgoing Accesses the Outgoing section of the current CANPort, which includes outgoing event-triggered and cyclic frames and data replay files.
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.)
Remove986xSupport Removes support for NI CompactRIO 986x CAN modules. You can use Set986xSupport to configure support.
RemoveAutomaticFrameProcessing Removes automatic frame processing from the CANPort.
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.)
Set986xSupport Configures support for NI CompactRIO 986x CAN modules.
SetAutomaticFrameProcessing Sets automatic frame processing on the CANPort. You must set automatic frame processing on the port if you want to configure CRCs and counters on outgoing frames under the port.
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
AFPBinaryFile Gets the binary (.ini) file used for automatic frame processing.
AFPGlobalData Gets the global data used for automatic frame processing.
AFPINIFile Gets the name of the AFPBinaryFile used for automatic frame processing.
BaseNodeType Gets a reference to the internal representation of this node. (Inherited from BaseNode.)
BaudRate Gets or sets the baud rate of the CAN port.
CANBusOff Gets or sets whether the CAN bus is recovered if it switches off due to a physical fault on the bus.
CANBusOffRate Gets or sets the bit rate at which to check the state of the CAN bus (active or off).
ClusterName Gets or sets the name of the cluster in LinkedDatabase that is associated with the CANPort.
Description Gets or sets the description of this node. (Inherited from BaseNode.)
Echo Gets or sets whether sessions contain frames that the interface transmits. If true (True in Visual Basic), when frame transmission is complete for an output (outgoing) session, the frame is echoed to the input (incoming) session.
IncomingRate Gets or sets the processing rate for incoming frames in hertz.
InlineIncoming Gets or sets whether to process incoming frames inline with the VeriStand Engine's Primary Control Loop (PCL). By default, NI VeriStand runs incoming and outgoing frame sessions asynchronously, or in a parallel loop to the PCL.
InlineOutgoing Gets or sets whether to process outgoing frames inline with the VeriStand Engine's Primary Control Loop (PCL). By default, NI VeriStand runs incoming and outgoing frame sessions asynchronously, or in a parallel loop to the PCL.
InputStreamQueueSize Gets or sets the queue size for the input stream. For signal I/O sessions, this is the number of signal values stored. For frame I/O sessions, this is the number of bytes of frame data stored.
LinkedDatabase Gets or sets the XNET database associated with the CANPort.
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.)
OutgoingRate Gets or sets the processing rate for outgoing frames in hertz.
PortNumber Gets or sets the physical address of the CAN port.
Termination Gets or sets the onboard XNETTermination.
TransceiverType Gets or sets the CANTransceiverType for the port. Transceivers can be high-speed (HS), low-speed (LS), or single wire (SW).
TransmitOrderType Gets or sets the CANTransmitOrderType for the port. You can transmit frames to the CAN bus AsSubmitted or ByIdentifier.
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