Jump to content

VI Server Class Hierarchy: Difference between revisions

From LabVIEW Wiki
← Older edit
Visual
Removed Table View
mNo edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{underconstruction}}
The '''VI Server Class Hierarchy''' is the object-oriented organization of all of the classes available in the [[VI Server]].  These classes define all of the elements in the [[G|G language]] and is the backbone for properties, (accessible by [[Property node|property node]]), methods, (accessible by [[Invoke Node|invoke node]]), and events.  The hierarchy consists of the following classes:
{{TOCright}}


The '''VI Server Class Hierarchy''' is the object-oriented organization of all of the classes available in the [[VI Server]].  These classes define all of the elements in the [[G|G language]] and is the backbone for properties, (accessible by [[Property node|property node]]), methods, accessible by ([[Invoke Node|invoke node]]), and events.  The hierarchy consists of the following classes:
__TOC__
{| class="wikitable"
! colspan="2"|Legend
|-
|B
|[[VI Server#Basic Development Environment|Basic Development Environment]]
|-
|S
|[[VI Server#VI Scripting|VI Scripting]]
|-
|P
|[[VI Server#Private|Private]]
|-
|B
|[[VI Server#Deprecated|Deprecated]]
|}
== Class Hierarchy Tree View ==
== Class Hierarchy Tree View ==
{{#tree:
{{#tree:
*[[Application class|Application]] (ClassID:1 [[VI Server#Basic Development Environment|B]])
*[[Application class|Application]] (ClassID:1 [[VI Server#Basic Development Environment|Basic Development Environment]])
*[[CopyConflict class|CopyConflict]] (ClassID:98 [[VI Server#Private|P]])
*[[CopyConflict class|CopyConflict]] (ClassID:98 [[VI Server#Private|Private]])
*[[CopyExpert class|CopyExpert]] (ClassID:99 [[VI Server#Private|P]])
*[[CopyExpert class|CopyExpert]] (ClassID:99 [[VI Server#Private|Private]])
*[[CopyItem class|CopyItem]] (ClassID:97 [[VI Server#Private|P]])
*[[CopyItem class|CopyItem]] (ClassID:97 [[VI Server#Private|Private]])
*[[CopyOperation class|CopyOperation]] (ClassID:94 [[VI Server#Private|P]])
*[[CopyOperation class|CopyOperation]] (ClassID:94 [[VI Server#Private|Private]])
*[[Generic class|Generic]] (ClassID:3 [[VI Server#Basic Development Environment|B]])
*[[Generic class|Generic]] (ClassID:3 [[VI Server#Basic Development Environment|Basic Development Environment]])
**[[Bus class|Bus]] (ClassID:131 [[VI Server#Basic Development Environment|B]])
**[[Bus class|Bus]] (ClassID:131 [[VI Server#Basic Development Environment|Basic Development Environment]])
**[[ConnectorPane class|ConnectorPane]] (ClassID:56 [[VI Server#VI Scripting|S]])
**[[ConnectorPane class|ConnectorPane]] (ClassID:56 [[VI Server#VI Scripting|VI Scripting]])
**[[Cursor class|Cursor]] (ClassID:38 [[VI Server#Basic Development Environment|B]])
**[[Cursor class|Cursor]] (ClassID:38 [[VI Server#Basic Development Environment|Basic Development Environment]])
**[[FlatSequenceFrame class|FlatSequenceFrame]] (ClassID:16479 [[VI Server#VI Scripting|S]])
**[[FlatSequenceFrame class|FlatSequenceFrame]] (ClassID:16479 [[VI Server#VI Scripting|VI Scripting]])
***[[TimeSequenceFrame class|TimeSequenceFrame]] (ClassID:16494 [[VI Server#VI Scripting|S]])
***[[TimeSequenceFrame class|TimeSequenceFrame]] (ClassID:16494 [[VI Server#VI
**[
}}
}}
[[VI Server Class Hierarchy Table|Click here for a tabular view of this data]]
== Programmatic Access to the VI Server Class Hierarchy ==
=== Programmatic Access to the Classes ===
[[File:AllTypes() property.png|frame|AllTypes[] property]]
Through [[VI Scripting]] the entire VI Server Class Hierarchy can be seen by accessing the [[ClassSpecifierConstant class/All Types() property|All Types[] property]] of the [[ClassSpecifierConstant class]].  This property returns an array of clusters with each element of the array representing one class in the hierarchy.  The cluster contains the following four elements about the class:
*Unique ID string - This is the class ID of the class
*Parent ID string - This is the Unique ID string of the Parent this class inherits from
*Class Name (unlocalized) - This is the name of the class in English
*Class Name (localized) - This is the name of the class in the language of the [[Development Environment|LabVIEW Integrated Development Environment (IDE)]]
=== Programmatic Access to the Properties ===
[[File:AllProps() property.png|frame|AllProps[] property]]
Through [[VI Scripting]] the all of the properties of a given class can be seen by accessing the [[Property class/All Supported Properties property|All Supported Properties property]] of the [[Property class]].  Start by setting the [[Property node|property node]] to the desired class.  Then, through scripting functions, get the reference to that property node and read the [[Property class/All Supported Properties property|All Supported Properties property]] of it.  It will return an array of clusters with each element of the array representing an acceptable property of the given class or of a class in its inheritance chain.  The cluster contains the following for elements about the property:
*Unique ID string - This is a unique ID for the property
*Data Name - This is the data name of the property
*Short Name (localized) - This is the name of the property as it would appear in a property node in the language of the [[Development Environment|LabVIEW IDE]]
*Long Name (localized) - This is the name of the property as it would appear in a drop-down menus as the property was being selected and is in the language of the [[Development Environment|LabVIEW IDE]]
=== Programmatic Access to the Methods ===
[[File:AllMeths() property.png|frame|AllMeths[] property]]
Through [[VI Scripting]] the all of the methods of a given class can be seen by accessing the [[Invoke class/All Supported Methods property|All Supported Methods property]] of the [[Invoke class]].  Start by setting the [[Invoke node|invoke node]] to the desired class.  Then, through scripting functions, get the reference to that invoke node and read the [[Invoke class/All Supported Methods property|All Supported Methods property]] of it.  It will return an array of clusters with each element of the array representing an acceptable method of the given class or of a class in its inheritance chain.  The cluster contains the following for elements about the method:
*Unique ID string - This is a unique ID for the method
*Data Name - This is the data name of the method
*Short Name (localized) - This is the name of the method as it would appear in a invoke node in the language of the [[Development Environment|LabVIEW IDE]]
*Long Name (localized) - This is the name of the method as it would appear in a drop-down menus as the method was being selected and is in the language of the [[Development Environment|LabVIEW IDE]]
=== The VI Server Toolkit ===
Use the [https://gpackage.io/packages/@qsi/viservertoolkit VI Server Toolkit] from QSI to easily query the VI Server for Classes, Properties, Methods, and Events information.  (Requires [[VI Scripting]]. The [https://gpackage.io/packages/@qsi/viservertoolkit VI Server Toolkit] is not for use in built applications.)
=== The Class Browser ===
The [[Class Browser]] is a built-in way to see the VI Server Classes, Properties and Methods.  (See the [[Class Browser]] page for more information.)


== History ==
== History ==
Line 330: Line 347:
|[[File:LV2016.png|frameless|border|64x64px|LabVIEW 2016|link=LabVIEW 2016]]
|[[File:LV2016.png|frameless|border|64x64px|LabVIEW 2016|link=LabVIEW 2016]]
|The [[InPlaceVariantAttributeNode class]], [[ClosureStructureNode class]], [[RaceStructureNode class]], and [[TargetStructureNode class]] was added.
|The [[InPlaceVariantAttributeNode class]], [[ClosureStructureNode class]], [[RaceStructureNode class]], and [[TargetStructureNode class]] was added.
|-
|[[File:LV8-2013.png|frameless|border|64x64px|LabVIEW 2010|link=LabVIEW 2010]]
|[[VI Scripting]] officially released and supported in [[LabVIEW 2010]].
|-
|[[File:LV8-2013.png|frameless|border|64x64px|LabVIEW 2009|link=LabVIEW 2009]]
|Early entry for [[VI Scripting]] downloadable from the [http://sine.ni.com/nips/cds/view/p/lang/en/nid/209110 NI Tools Network] for [[LabVIEW 8.6]] and [[LabVIEW 2009]].
|}
|}


Line 335: Line 358:


== References ==
== References ==
[[Category:VI Server]]
[[Category:Classes]]
[[Category:Properties]]
[[Category:Methods]]

Latest revision as of 20:09, 6 June 2020

The VI Server Class Hierarchy is the object-oriented organization of all of the classes available in the VI Server. These classes define all of the elements in the G language and is the backbone for properties, (accessible by property node), methods, (accessible by invoke node), and events. The hierarchy consists of the following classes:

Class Hierarchy Tree View

Click here for a tabular view of this data

Programmatic Access to the VI Server Class Hierarchy

Programmatic Access to the Classes

AllTypes[] property

Through VI Scripting the entire VI Server Class Hierarchy can be seen by accessing the All Types[] property of the ClassSpecifierConstant class. This property returns an array of clusters with each element of the array representing one class in the hierarchy. The cluster contains the following four elements about the class:

  • Unique ID string - This is the class ID of the class
  • Parent ID string - This is the Unique ID string of the Parent this class inherits from
  • Class Name (unlocalized) - This is the name of the class in English
  • Class Name (localized) - This is the name of the class in the language of the LabVIEW Integrated Development Environment (IDE)

Programmatic Access to the Properties

AllProps[] property

Through VI Scripting the all of the properties of a given class can be seen by accessing the All Supported Properties property of the Property class. Start by setting the property node to the desired class. Then, through scripting functions, get the reference to that property node and read the All Supported Properties property of it. It will return an array of clusters with each element of the array representing an acceptable property of the given class or of a class in its inheritance chain. The cluster contains the following for elements about the property:

  • Unique ID string - This is a unique ID for the property
  • Data Name - This is the data name of the property
  • Short Name (localized) - This is the name of the property as it would appear in a property node in the language of the LabVIEW IDE
  • Long Name (localized) - This is the name of the property as it would appear in a drop-down menus as the property was being selected and is in the language of the LabVIEW IDE

Programmatic Access to the Methods

AllMeths[] property

Through VI Scripting the all of the methods of a given class can be seen by accessing the All Supported Methods property of the Invoke class. Start by setting the invoke node to the desired class. Then, through scripting functions, get the reference to that invoke node and read the All Supported Methods property of it. It will return an array of clusters with each element of the array representing an acceptable method of the given class or of a class in its inheritance chain. The cluster contains the following for elements about the method:

  • Unique ID string - This is a unique ID for the method
  • Data Name - This is the data name of the method
  • Short Name (localized) - This is the name of the method as it would appear in a invoke node in the language of the LabVIEW IDE
  • Long Name (localized) - This is the name of the method as it would appear in a drop-down menus as the method was being selected and is in the language of the LabVIEW IDE

The VI Server Toolkit

Use the VI Server Toolkit from QSI to easily query the VI Server for Classes, Properties, Methods, and Events information. (Requires VI Scripting. The VI Server Toolkit is not for use in built applications.)

The Class Browser

The Class Browser is a built-in way to see the VI Server Classes, Properties and Methods. (See the Class Browser page for more information.)

History

Version Change(s)
LabVIEW 2019 The MapConstant class, SetConstant class, Map class, Set class, AssertStructuralTypeMismatchNode class, BuildMapNode class, BuildSetNode class, InPlaceMapNode class was added. The TargetStructureNode class was moved from being a child of the Structure class to being a child of the MultiFrameStructure class
LabVIEW 2018 The ExternalEditorWizard class was added.
LabVIEW 2016 The InPlaceVariantAttributeNode class, ClosureStructureNode class, RaceStructureNode class, and TargetStructureNode class was added.
LabVIEW 2010 VI Scripting officially released and supported in LabVIEW 2010.
LabVIEW 2009 Early entry for VI Scripting downloadable from the NI Tools Network for LabVIEW 8.6 and LabVIEW 2009.

External Links

References

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