Jump to content

StatechartLibrary class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
m Removed VI Server Category from page
 
(One intermediate revision by the same user not shown)
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 StatechartLibrary Properties Table</span>
{{VIServerClassTables|126}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ StatechartLibrary Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|18A16800
| [[StatechartLibrary class/Codegen Needed property|Codegen Needed]]
|Returns TRUE when the statechart has changes that require you to generate code for the statechart.
|R
|
|- style="background-color:#FFFFCC;"
|18A16801
| [[StatechartLibrary class/Has Diagram Errors property|Has Diagram Errors]]
|Returns TRUE when the statechart diagram contains errors.
|R
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide StatechartLibrary Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ StatechartLibrary Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|18A16402
| [[StatechartLibrary class/Generate Code method|Generate Code]]
|Generates code for the statechart and optionally saves the statechart. The statechart is saved only if code generation occurs and the Save Statechart parameter is TRUE.
|
|- style="background-color:#FFFFCC;"
|18A16403
| [[StatechartLibrary class/Generate Documentation method|Generate Documentation]]
|Generates an XML file that contains information about all components, including states, pseudostates, connectors, regions, and transitions, of a statechart. You can view the XML file in a Web browser.
 
This method also generates a folder of support files in the same location as the XML file you generate. This support folder contains files that the XML file references, including images of the statechart components, an EXtensible Stylesheet Language Transformations (XSLT) file, and an XML Schema Definition (XSD) file.
 
<b>Note</b>  You may freely distribute your generated XML file and support folder containing the XSLT and XSD files. However, National Instruments claims all copyrights on NI_Statechart_Documentation_Tool.xslt and NI_Statechart_Documentation_Tool.xsd. Do not use or distribute these files except with the associated XML file and support folder generated by the LabVIEW Statechart Module Generate Documentation feature. You may modify NI_Statechart_Documentation_Tool.xslt, but the file must retain the National Instruments copyright notice contained therein, which may not be modified or obscured. You also must add a prominent notice at the top of the file that states that you have modified the file. You may not modify NI_Statechart_Documentation_Tool.xsd.
This method is similar to the <b>Generate Documentation</b> item on the shortcut menu of an .lvsc item, or statechart library, in a statechart project. This method also is similar to the <b>File&#0187;Generate Documentation</b> menu item in the Statechart Editor window.
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 78: Line 24:
*[[VI Server]]
*[[VI Server]]


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

Latest revision as of 02:03, 8 May 2020

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

This class has no children.


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

Properties

Show/Hide StatechartLibrary Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
StatechartLibrary Properties Table
Property ID Long Name (English) Description R/W RTE
18A16800Code Generation NeededReturns TRUE when the statechart has changes that require you to generate code for the statechart.Read OnlyNo
18A16801Has Diagram ErrorsReturns TRUE when the statechart diagram contains errors.Read OnlyNo

Methods

Show/Hide StatechartLibrary Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
StatechartLibrary Methods Table
Method ID Long Name (English) Description RTE
18A16402Generate CodeGenerates code for the statechart and optionally saves the statechart. The statechart is saved only if code generation occurs and the Save Statechart parameter is TRUE.No
18A16403Generate DocumentationGenerates an XML file that contains information about all components, including states, pseudostates, connectors, regions, and transitions, of a statechart. You can view the XML file in a Web browser.No

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