Jump to content

Generic class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{| class="wikitable"
{{VIServerClass|3}}
|-
|<[[VI Server Class Hierarchy]]
|}
 
The '''Application class''' is a class in the [[VI Server Class Hierarchy]], (see also [[VI Server]]).  The Application class is the top-level instance of the application in its context.  Multiple [[Application instance|application instances]] can be open at a time.
{{TOCright}}
{| class="wikitable"
! colspan="2"|Legend
|-
|R/W
| Readable/Writable {R = Read Only, W = Write Only, R/W = Read/Write}
|-
|RTE
| Available in the [[Run-Time Engine]]
|- style="background-color:#FFFFCC;"
|colspan="2"|[[VI Server#Basic Development Environment|Basic Development Environment]]
|-style="background-color:#CCFFFF;"
|colspan="2"|[[VI Server#VI Scripting|VI Scripting]]
|-style="background-color:#D1BB80;"
|colspan="2"|[[VI Server#Private|Private]]
|-style="background-color:#FFAAAA;"
|colspan="2"|[[VI Server#Deprecated|Deprecated]]
|}


==Properties==
{{stub}}
<span class="mw-customtoggle-propertiestable">Show/Hide Application Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{| class="wikitable sortable"
|+ Application Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6327800
| [[Generic class/ClassID property|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.
The '''Generic class''' is a class in the [[VI Server Class Hierarchy]], (see also [[VI Server]]).
|R
|X
|- style="background-color:#FFFFCC;"
|6327803
| [[Generic class/ClassName property|ClassName]]
|Name of the VI Server class that contains the object.
|R
|X
|- style="background-color:#CCFFFF;"
|6327805
| [[Generic class/Is On BD? property|Is On BD?]]
|Returns TRUE when the object is located on the block diagram.
|R
|X
|- style="background-color:#D1BB80;"
|6327804
| [[Generic class/Modified property|Modified]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|6327806
| [[Generic class/Owner property|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.
{{TOCright}}
|R
|X
|- style="background-color:#FFFFCC;"
|6327802
| [[Generic class/OwningVI property|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
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Application Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{| class="wikitable sortable"
|+ Application Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6327405
| [[Generic class/Class Operator.Call method|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
|- style="background-color:#CCFFFF;"
|6327406
| [[Generic class/Class Operator.Traverse method|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.
 
<b>Caution</b>  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
|- style="background-color:#CCFFFF;"
|6327400
| [[Generic class/Delete method|Delete]]
|Deletes the object. After LabVIEW deletes the object, all references to the object are invalid.
|X
|- style="background-color:#D1BB80;"
|6327408
| [[Generic class/Get Property method|Get Property]]
|
|X
|- style="background-color:#D1BB80;"
|6327409
| [[Generic class/Get Property Call Data method|Get Property Call Data]]
|
|X
|- style="background-color:#D1BB80;"
|632740B
| [[Generic class/NI Sec.Get ACL method|NI Sec.Get ACL]]
|
|X
|- style="background-color:#D1BB80;"
|632740C
| [[Generic class/NI Sec.Remove ACL method|NI Sec.Remove ACL]]
|
|X
|- style="background-color:#D1BB80;"
|632740A
| [[Generic class/NI Sec.Set ACL method|NI Sec.Set ACL]]
|
|X
|- style="background-color:#D1BB80;"
|632740D
| [[Generic class/SetHeapDocModForObject method|SetHeapDocModForObject]]
|
|
|- style="background-color:#D1BB80;"
|6327407
| [[Generic class/Set Property method|Set Property]]
|
|X
|- style="background-color:#CCFFFF;"
|6327403
| [[Generic class/Tag.Get Tag method|Tag.Get Tag]]
|Returns a tag value associated with the tag.  Returns FALSE if the tag does not exist.
|X
|- style="background-color:#CCFFFF;"
|6327402
| [[Generic class/Tag.Remove Tag method|Tag.Remove Tag]]
|Removes the specified tag.  Returns FALSE if LabVIEW did not remove the tag.
|X
|- style="background-color:#CCFFFF;"
|6327401
| [[Generic class/Tag.Set Tag method|Tag.Set Tag]]
|Sets a tag value.  Returns FALSE if LabVIEW does not set the tag value.
|X
|- style="background-color:#CCFFFF;"
|6327404
| [[Generic class/Tag.Set Tag Persistence method|Tag.Set Tag Persistence]]
|Sets the persistence of the tag.  Returns FALSE if not found.
|X
|}
</div>


==Events==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VIServer Templates-->
''No Events for this Class''
{{VIServerClassTables|3}}


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
Line 180: Line 24:
*[[VI Server]]
*[[VI Server]]
*[[VI Scripting]]
*[[VI Scripting]]
*[[Application reference]]
*[[Application instance]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 01:57, 8 May 2020

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


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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 Long Name (English) Description R/W RTE
6327800Class IDClass identifier of the object.Read OnlyYes (Read Only)
6327801Owner (Deprecated)Read OnlyYes
6327802Owning VIReturns 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.Read OnlyYes (Read Only)
6327803Class NameName of the VI Server class that contains the object.Read OnlyYes (Read Only)
6327804ModifiedRead OnlyYes
6327805Is On Block Diagram?Returns TRUE when the object is located on the block diagram.Read OnlyYes
6327806OwnerReference 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.Read OnlyYes (Read Only)

Methods

Show/Hide Generic Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Generic Methods Table
Method ID Long Name (English) Description RTE
6327400DeleteDeletes the object. After LabVIEW deletes the object, all references to the object are invalid.Yes (Read/Write)
6327401Tag:Set TagSets a tag value. Returns FALSE if LabVIEW does not set the tag value.Yes (Read/Write)
6327402Tag:Remove TagRemoves the specified tag. Returns FALSE if LabVIEW did not remove the tag.Yes (Read/Write)
6327403Tag:Get TagReturns a tag value associated with the tag. Returns FALSE if the tag does not exist.Yes (Read/Write)
6327404Tag:Set Tag PersistenceSets the persistence of the tag. Returns FALSE if not found.Yes (Read/Write)
6327405Class Operator:CallCalls the VI associated with the Operator Name, on the object. Returns FALSE if no operator VI is associated with the class of the object.Yes (Read/Write)
6327406Class Operator:TraverseTraverses 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.Yes (Read/Write)
6327407Set PropertyYes
6327408Get PropertyYes
6327409Get Property Call DataYes
632740ANI Security:Set Access Control ListYes
632740BNI Security:Get Access Control ListYes
632740CNI Security:Remove Access Control ListYes
632740DSet HeapDocMod For ObjectNo

Events

This class has no events.


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=Generic_class&oldid=26606"