Jump to content

Generic class

From LabVIEW Wiki
Revision as of 17:01, 1 September 2019 by Q (talk | contribs)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Generic class
Class ID 3
Scope Basic Development Environment
Class Inheritance

This class is a top-level class.

Class Children


The Generic class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Generic Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Generic Properties Table
Property ID Short Name (English) Description R/W RTE
6327800 ClassID Class identifier of the object.

This integer uniquely identifies the class of a LabVIEW object. To view the corresponding class name of a LabVIEW object, use the Class Name property.

R X
6327803 ClassName Name of the VI Server class that contains the object. R X
6327805 Is On BD? Returns TRUE when the object is located on the block diagram. R X
6327804 Modified R X
6327806 Owner Reference to the owning object. The type of the reference is Generic. An object of class Panel does not have an owner (it is the top-level object) and always returns Not A Refnum.

All objects in LabVIEW have an owning object. For example, the front panel and block diagram are the owning objects of all the objects contained within each, including controls and indicators. However, if a control is a cluster, the cluster would the owning object of all the objects inside it. Likewise, if the block diagram contains a sequence structure, the structure is the owning object of all the objects inside it. Individual controls also can be the owning object of less obvious objects. For example, numeric controls own their label, caption, and the increment and decrement buttons.

R X
6327802 OwningVI Returns a reference to the VI that owns this object. Close this reference when you are finished using it. The reference this property returns does not keep the VI in memory. If the owning VI is removed from memory, this reference becomes invalid. Use the Open VI Reference function to obtain a reference to a VI that stays in memory until you explicitly close the reference. R X

Methods

Show/Hide Generic Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Generic Methods Table
Method ID Short Name (English) Description RTE
6327405 Class Operator.Call Calls the VI associated with the Operator Name, on the object. Returns FALSE if no operator VI is associated with the class of the object. X
6327406 Class Operator.Traverse Traverses the object tree of a specified object and performs a function on any object that has a process specified. If the traverse fails, LabVIEW returns FALSE.

Traverse is a way to find object references without having to recursively find them in a VI or block diagram.

Caution Do not attempt to modify code in traverse callbacks. This changes the stack the traverse operation is iterating through and can cause LabVIEW to crash.

X
6327400 Delete Deletes the object. After LabVIEW deletes the object, all references to the object are invalid. X
6327408 Get Property X
6327409 Get Property Call Data X
632740B NI Sec.Get ACL X
632740C NI Sec.Remove ACL X
632740A NI Sec.Set ACL X
632740D SetHeapDocModForObject
6327407 Set Property X
6327403 Tag.Get Tag Returns a tag value associated with the tag. Returns FALSE if the tag does not exist. X
6327402 Tag.Remove Tag Removes the specified tag. Returns FALSE if LabVIEW did not remove the tag. X
6327401 Tag.Set Tag Sets a tag value. Returns FALSE if LabVIEW does not set the tag value. X
6327404 Tag.Set Tag Persistence Sets the persistence of the tag. Returns FALSE if not found. X

Events

No Events for this class.

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also