CustomDevice Members
- Updated2023-02-21
- 15 minute(s) read
The CustomDevice type exposes the following members.
| Name | Description | |
|---|---|---|
 | CustomDevice | Initializes a new instance of the CustomDevice class. |
Methods
| Name | Description | |
|---|---|---|
| AddCustomDeviceChannelIfNotFound | Adds a custom device channel with the name and guid you specify to the current section, if the channel does not already exist under the section. If the channel you specify already exists, this method takes no action and returns a reference to the existing channel. (Inherited from CustomDeviceSection.) |
| AddCustomDeviceSectionIfNotFound | Adds a custom device subsection with the name and guid you specify to the current section, if the subsection does not already exist under the section. If the subsection does exist, this method does nothing. (Inherited from CustomDeviceSection.) |
| AddCustomDeviceWaveformIfNotFound | Adds a CustomDeviceWaveform with the name, dataType and guid you specify to the current section, if the CustomDeviceWaveform does not already exist under the section. If the CustomDeviceWaveform you specify already exists, this method takes no action and returns a reference to the existing CustomDeviceWaveform. (Inherited from CustomDeviceSection.) |
| AddDependencies | Adds dependencies to a custom device. Dependencies are any files, such as DLLs or VIs, that the custom device requires and that you want to deploy to the target along with the custom device. |
| AddErrorChannel | Adds an error channel to the custom device. An asynchronous custom device can send a fatal error status to the Primary Control Loop of the VeriStand Engine by writing a non-zero error code value to this channel. (Inherited from CustomDeviceSection.) |
| AddInputOverflowCountChannel | Adds an input overflow count channel to a section in an asynchronous custom device. Input overflow count channels track the number of times the system fails to write data to an asynchronous custom device because the FIFO is full. A custom device can have only one input overflow count channel. (Inherited from CustomDeviceSection.) |
| AddOutputUnderflowCountChannel | Adds an output underflow count channel to a section in an asynchronous custom device. Output underflow count channels track the number of times the system fails to read data from an asynchronous custom device because there is no data to read. A custom device can have only one output underflow count channel. (Inherited from CustomDeviceSection.) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize | Class Destructor (Overrides CustomDeviceSection.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.) |
| GetBinaryStringProperty | Gets the binary string value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetBooleanProperty | Gets the Boolean value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetChildren | Gets an array that contains the child BaseNode elements of the current node. (Inherited from BaseNode.) |
| GetCustomDeviceChannelList | Gets an array that contains the CustomDeviceChannel elements from the current CustomDevice. |
| GetCustomDeviceSectionList | Gets an array that contains the CustomDeviceSection elements from the current CustomDevice. Sections are not required in custom devices, but provide a way to organize custom device channels into a logical hierarchy. |
| GetCustomDeviceWaveformList | Gets an array that contains the CustomDeviceWaveform elements from the current CustomDevice. |
| GetDependencies | Gets an array that contains the DependentFile elements from the current CustomDevice. Dependent files are any files that the device requires and that deploy to the target along with the custom device. |
| GetDependentFileProperty | Gets the reference to the dependent file that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetDependentNodeProperty | Overloaded.
Gets the reference to the dependent node that is the value of the custom device item property specified by name.
|
| GetDictionaryArrayProperty | Gets the reference to the Dictionary array that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetDictionaryProperty | Gets the reference to the Dictionary that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| 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.) |
| GetDoubleArrayProperty | Gets the array of double-precision floating point numbers that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetDoubleProperty | Gets the double-precision floating point value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetDriverVIForOwnerTargetType | Gets the RT Driver VI for the target indicated by the custom device. A single custom device can have multiple RT Driver VIs if the device supports multiple real-time operating systems or multiple execution modes. |
| GetDriverVIs | Gets all the RT Driver VIs associated with the custom device. A single custom device can have multiple RT Driver VIs if the device supports multiple real-time operating systems or multiple execution modes. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetI32ArrayProperty | Gets the array of 32-bit signed integers that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetI32Property | Gets the 32-bit signed integer that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetParent | Gets the parent node of this node. (Inherited from BaseNode.) |
| GetPropertyNames | Gets the names of all the properties associated with a custom device item. Custom device item properties store and communicate state information. (Inherited from CustomDeviceBase.) |
| GetPropertyType | Gets the data type of the custom device item property specified by propertyName. (Inherited from CustomDeviceBase.) |
| GetStringArrayProperty | Gets the array of strings that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetStringProperty | Gets the string value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetTimingSourceInitVIs | Gets the Timing Source Initialization VIs associated with the custom device. If you configure the custom device as the master timing source for the target, these VIs create a timing source for the Primary Control Loop. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetU16Property | Gets the unsigned 16-bit integer value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetU32ArrayProperty | Gets the array of unsigned 32-bit integers that is the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetU32Property | Gets the unsigned 32-bit integer value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetU64Property | Gets the unsigned 64-bit integer value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| GetVariantProperty | Gets the LabVIEW variant value of the custom device item property specified by name. The variant data type is a generic container for all other LabVIEW data types. (Inherited from CustomDeviceBase.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MoveNodeTo | Moves a custom device item to a new location within the custom device hierarchy. (Inherited from CustomDeviceBase.) |
| RemoveError | Removes an error that matches the specified ErrorID. (Inherited from CustomDeviceBase.) |
| RemoveNode | Removes this node from the hierarchy, if the node can be removed. (Inherited from BaseNode.) |
| RemoveProperty | Removes the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| RenameNode | Overloaded.
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.
|
| ReportError | Configures whether to report an error that occurs during custom device execution. (Inherited from CustomDeviceBase.) |
| ResetDependencies | Removes all the dependencies from the custom device. Dependencies are any files, such as DLLs or VIs, that the custom device requires and that you want to deploy to the target along with the custom device. |
| SetBinaryStringProperty | Sets a binary string value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetBooleanProperty | Sets a Boolean value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetDependentFileProperty | Sets a reference to a dependent file as the value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetDependentNodeProperty | Overloaded.
Sets a reference to a dependent node as the value of the custom device item property specified by name.
|
| SetDictionaryArrayProperty | Sets a reference to a Dictionary as the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetDictionaryProperty | Sets a reference to a Dictionary element as the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetDoubleArrayProperty | Sets an array of double-precision floating point numbers as the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetDoubleProperty | Sets a double-precision floating point value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetDriverVIs | Sets the RT Driver VIs to associate with the custom device. A custom device requires at least one RT Driver VI. A single custom device can have multiple RT Driver VIs if the device supports multiple real-time operating systems or multiple execution modes. |
| SetI32ArrayProperty | Sets an array of 32-bit signed integers as the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetI32Property | Sets a 32-bit signed integer value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetStringArrayProperty | Sets an array of strings as the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetStringProperty | Sets a string value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetTimingSourceInitVIs | Sets the Timing Source Initialization VIs to associate with the custom device. Timing Source Initialization VIs are required if you want to use a custom device that is not a timing and sync device as the master timing source for the Primary Control Loop. |
| SetU16Property | Sets an unsigned 16-bit integer value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetU32ArrayProperty | Sets an array of unsigned 32-bit integers as the value of the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetU32Property | Sets an unsigned 32-bit integer value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetU64Property | Sets an unsigned 64-bit integer value for the custom device item property specified by name. (Inherited from CustomDeviceBase.) |
| SetVariantProperty | Sets a LabVIEW variant value for the custom device item property specified by name. The variant data type is a generic container for all other LabVIEW data types. (Inherited from CustomDeviceBase.) |
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | BaseNodeType | Gets a reference to the internal representation of this node. (Inherited from BaseNode.) |
| Decimation | Gets or sets the decimation factor for the custom device, which determines how many iterations of the Primary Control Loop (PCL) occur between calls to the custom device. |
| Description | Gets or sets the description of this node. (Inherited from BaseNode.) |
| DeviceEnabledState | Gets or sets the state (enabled or disabled) of the custom device. |
| DriverVIExecutionMode | Gets or sets the execution mode of the custom device, such as if it runs inline with the Primary Control Loop or asynchronously. |
| FIFOSinkDepth | Gets or sets the depth of the FIFO at the sink. This property defines the size of the buffer for outgoing data. This property only applies to asynchronous custom devices. |
| FIFOSourceDepth | Gets or sets the depth of the FIFO at the source. This property defines the size of the buffer for incoming data. This property only applies to asynchronous custom devices. |
| LoopType |
Gets or sets the type of loop (TimedLoop or WhileLoop) in which the custom device runs. This property only applies to asynchronous custom devices.
|
| 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.) |
| TimedLoopPriority |
Gets or sets the priority (High, Low, or Medium) of the Timed Loop in which an asynchronous custom device runs. This property only applies to asynchronous custom devices that run in Timed Loops.
|
| TypeGUID | Gets or sets the GUID associated with an item in a custom device. You can use this property to get or set the GUID for any component of a custom device that lists a GUID in the Custom Device XML file, such as the configuration page for the item, menu items that appear at run-time, Action VIs associated with the item, and so on. (Inherited from CustomDeviceBase.) |
| UseDeviceClock | Gets or sets whether the Timed Loop in which an asynchronous custom device runs is synchronized with the Primary Control Loop (PCL) timing source. This property only applies to asynchronous custom devices that run in Timed Loops. |
| Version | Gets or sets information stored with a custom device, such as version information. You can read this string to determine whether to update device dependencies or, if you are migrating a custom device to a new version of NI VeriStand, to determine whether to run mutation code. |