Jump to content

LVClassLibrary class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
Replaced with template tables
Tag: Replaced
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide LVClassLibrary Properties Table</span>
{{VIServerClassTables|85}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ LVClassLibrary Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|97D7014
| [[LVClassLibrary class/AncestorRestrictsRefs property|AncestorRestrictsRefs]]
|Property indicates that an ancestor class controls the creation of data value references to this class.  Only the ancestors member VIs can create data value references.
|R
|
|- style="background-color:#FFFFCC;"
|97D7013
| [[LVClassLibrary class/ChildRefsRestricted property|ChildRefsRestricted]]
|Property indicates whether data value references to all of this class descendants can be created only in member VIs of this class.
|R/W
|X
|- style="background-color:#FFFFCC;"
|97D7004
| [[LVClassLibrary class/ChildrenInMemory() property|ChildrenInMemory()]]
|Returns an array of references to all LabVIEW classes in memory that directly inherit from the referenced class. This property does not return additional descendents of the child classes.
|R
|X
|- style="background-color:#FFFFCC;"
|97D7010
| [[LVClassLibrary class/DefaultProbe property|DefaultProbe]]
|Returns a reference to the default probe for the LabVIEW class library. The default probe is the probe LabVIEW uses when you first create a probe from a wire of this class type.
|R/W
|
|- style="background-color:#FFFFCC;"
|97D7015
| [[LVClassLibrary class/DynamicMemberVIs() property|DynamicMemberVIs()]]
|Returns an array of references to the member VIs of the referenced LabVIEW class that contain a dynamic dispatch terminal. To obtain references to the methods  of the referenced class that do not contain a dynamic dispatch terminal, use the Static Member VIs[] property.
|R
|X
|- style="background-color:#D1BB80;"
|97D700E
| [[LVClassLibrary class/ModDate property|ModDate]]
|
|R
|X
|- style="background-color:#D1BB80;"
|97D7009
| [[LVClassLibrary class/NameVisibleInProbe property|NameVisibleInProbe]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|97D7003
| [[LVClassLibrary class/ParentClass property|ParentClass]]
|Gets or sets the LabVIEW class from which the referenced class directly inherits.
 
If the referenced class directly inherits from the LabVIEW Object class, this property returns Not a Refnum. To set the parent of the referenced class to be LabVIEW Object, wire a Not a Refnum constant to this property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|97D700F
| [[LVClassLibrary class/Private Data Control property|Private Data Control]]
|Returns a reference to the control that contains the private data of this LabVIEW class.
|R
|X
|- style="background-color:#D1BB80;"
|97D700D
| [[LVClassLibrary class/Probes property|Probes]]
|
|R
|X
|- style="background-color:#D1BB80;"
|97D7005
| [[LVClassLibrary class/Properties property|Properties]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|97D7012
| [[LVClassLibrary class/SelfRefsRestricted property|SelfRefsRestricted]]
|Property indicates that data value references to this class can only be created/deleted by member VIs of this class.
|R/W
|X
|- style="background-color:#FFFFCC;"
|97D7002
| [[LVClassLibrary class/SimpleName property|SimpleName]]
|Returns the name of the class without prepending namespace information from owning classes.
 
To change the name of the class, use the Save As method.
|R
|X
|- style="background-color:#FFFFCC;"
|97D7016
| [[LVClassLibrary class/StaticMemberVIs() property|StaticMemberVIs()]]
|Returns an array of references to the members VIs of the referenced LabVIEW class that do not contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that contain a dynamic dispatch terminal, use the Dynamic Member VIs[] property.
|R
|X
|- style="background-color:#FFFFCC;"
|97D7011
| [[LVClassLibrary class/TransferMustOverrides? property|TransferMustOverrides?]]
|Determines whether to allow the class to transfer all override requirements to any descendant classes instead of overriding the dynamic dispatch VI itself.
 
This property is similar to the <b>Transfer all override requirements to descendant classes</b> checkbox of the Inheritance page of the Class Properties dialog box.
|R/W
|
|- style="background-color:#FFFFCC;"
|97D700A
| [[LVClassLibrary class/WirePens property|WirePens]]
|Gets or sets the appearance of the wire associated with this LabVIEW class.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide LVClassLibrary Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ LVClassLibrary Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|97D6C02
| [[LVClassLibrary class/Add Dynamic Member VI method|Add Dynamic Member VI]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C04
| [[LVClassLibrary class/Add Probe method|Add Probe]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C01
| [[LVClassLibrary class/Add Property method|Add Property]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C03
| [[LVClassLibrary class/Add Static Member VI method|Add Static Member VI]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C09
| [[LVClassLibrary class/Clone Member Data method|Clone Member Data]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C11
| [[LVClassLibrary class/DeParent Class method|DeParent Class]]
|
|
|- style="background-color:#FFFFCC;"
|97D6C0D
| [[LVClassLibrary class/Get MustCallParent? method|Get MustCallParent?]]
|Indicates whether the member VI specified by <b>Dynamic Member VI</b> requires each child class VI that overrides the member VI to call the member VI with the Call Parent Method Node.
|
|- style="background-color:#FFFFCC;"
|97D6C0E
| [[LVClassLibrary class/Set MustCallParent? method|Set MustCallParent?]]
|Determines whether the member VI specified by <b>Dynamic Member VI</b> requires each child class VI that overrides the member VI to call the member VI with the Call Parent Method Node.
 
This method is similar to the <b>Require overrides of this dynamic dispatch VI to always invoke the Call Parent Node</b> checkbox on the Item Settings page of the Class Properties dialog box.
|
|- style="background-color:#FFFFCC;"
|97D6C0B
| [[LVClassLibrary class/Get MustOverride? method|Get MustOverride?]]
|Indicates whether descendant classes must override the member VI specified by the <b>Dynamic Member VI</b> reference.
|
|- style="background-color:#FFFFCC;"
|97D6C0C
| [[LVClassLibrary class/Set MustOverride? method|Set MustOverride?]]
|Determines whether descendant classes must override the member VI specified by <b>Dynamic Member VI</b>.
 
This method is similar to the <b>Require descendant classes to override this dynamic dispatch VI</b> checkbox of the Item Settings page of the Class Properties dialog box.
|
|- style="background-color:#D1BB80;"
|97D6C10
| [[LVClassLibrary class/Get Prop Def Folder by Unique ID method|Get Prop Def Folder by Unique ID]]
|
|
|- style="background-color:#FFFFCC;"
|97D6C0F
| [[LVClassLibrary class/HasImplementation method|HasImplementation]]
|Returns TRUE if the class contains the specified VI. If the VI exists, this method returns the path and qualified name of the VI. If the class contains the specified VI, but the VI has never been saved, this method returns  and a valid qualified name.
|
|- style="background-color:#D1BB80;"
|97D6C06
| [[LVClassLibrary class/Remove Member VI method|Remove Member VI]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C07
| [[LVClassLibrary class/Remove Probe method|Remove Probe]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C05
| [[LVClassLibrary class/Remove Property method|Remove Property]]
|
|X
|- style="background-color:#D1BB80;"
|97D6C0A
| [[LVClassLibrary class/Set Member Data method|Set Member Data]]
|
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 01:19, 9 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name LVClassLibrary class
Class ID 85
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


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

Properties

Show/Hide LVClassLibrary Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
LVClassLibrary Properties Table
Property ID Long Name (English) Description R/W RTE
97D7002Simple NameReturns the name of the class without prepending namespace information from owning classes.Read OnlyNo
97D7003Parent ClassGets or sets the LabVIEW class from which the referenced class directly inherits.Read/WriteNo
97D7004Children In Memory[]Returns an array of references to all LabVIEW classes in memory that directly inherit from the referenced class. This property does not return additional descendents of the child classes.Read OnlyNo
97D7005PropertiesRead OnlyYes
97D7006Dynamic Member VIsRead OnlyYes
97D7007Static Member VIsRead OnlyYes
97D7009Name Visible In ProbeRead/WriteYes
97D700AWire PensGets or sets the appearance of the wire associated with this LabVIEW class.Read/WriteNo
97D700BDefault InstanceRead OnlyNo
97D700DProbesRead OnlyYes
97D700EModification DateRead OnlyYes
97D700FPrivate Data ControlReturns a reference to the control that contains the private data of this LabVIEW class.Read OnlyNo
97D7010DefaultProbeReturns a reference to the default probe for the LabVIEW class library. The default probe is the probe LabVIEW uses when you first create a probe from a wire of this class type.Read/WriteNo
97D7011Transfer Must Overrides?Determines whether to allow the class to transfer all override requirements to any descendant classes instead of overriding the dynamic dispatch VI itself.Read/WriteNo
97D7012Self References RestrictedProperty indicates that data value references to this class can only be created/deleted by member VIs of this class.Read/WriteNo
97D7013Child References RestrictedProperty indicates whether data value references to all of this class descendants can be created only in member VIs of this class.Read/WriteNo
97D7014Ancestor Restricts Reference CreationProperty indicates that an ancestor class controls the creation of data value references to this class. Only the ancestors member VIs can create data value references.Read OnlyNo
97D7015Dynamic Member VIs[]Returns an array of references to the member VIs of the referenced LabVIEW class that contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that do not contain a dynamic dispatch terminal, use the Static Member VIs() property.Read OnlyNo
97D7016Static Member VIs[]Returns an array of references to the members VIs of the referenced LabVIEW class that do not contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that contain a dynamic dispatch terminal, use the Dynamic Member VIs() property.Read OnlyNo

Methods

Show/Hide LVClassLibrary Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
LVClassLibrary Methods Table
Method ID Long Name (English) Description RTE
97D6C01Add PropertyYes
97D6C02Add Dynamic Member VIYes
97D6C03Add Static Member VIYes
97D6C04Add ProbeYes
97D6C05Remove PropertyYes
97D6C06Remove Member VIYes
97D6C07Remove ProbeYes
97D6C09Clone Member DataYes
97D6C0ASet Member DataYes
97D6C0BDescendants Must Override Item?:GetIndicates whether descendant classes must override the member VI specified by the Dynamic Member VI reference.No
97D6C0CDescendants Must Override Item?:SetDetermines whether descendant classes must override the member VI specified by Dynamic Member VI.No
97D6C0DDescendants Must Call Parent Item?:GetIndicates whether the member VI specified by Dynamic Member VI requires each child class VI that overrides the member VI to call the member VI with the Call Parent Method Node.No
97D6C0EDescendants Must Call Parent Item?:SetDetermines whether the member VI specified by Dynamic Member VI requires each child class VI that overrides the member VI to call the member VI with the Call Parent Method Node.No
97D6C0FHas Implementation?Returns TRUE if the class contains the specified VI. If the VI exists, this method returns the path and qualified name of the VI. If the class contains the specified VI, but the VI has never been saved, this method returns <Not A Path> and a valid qualified name.No
97D6C10Get Property Definition Folder by Unique IDNo
97D6C11DeParent ClassNo

Events

This class has no events or it inherits events from its parent: Library Class.


History

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

See Also