Jump to content

StatechartLibrary class

From LabVIEW Wiki
Revision as of 00:22, 27 August 2019 by Q (talk | contribs) (Started page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name class
Class ID {{{1}}}
Scope
Class Inheritance

This class is a top-level class.

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 Short Name (English) Description R/W RTE
18A16800 Codegen Needed Returns TRUE when the statechart has changes that require you to generate code for the statechart. R
18A16801 Has Diagram Errors Returns TRUE when the statechart diagram contains errors. R

Methods

Show/Hide StatechartLibrary Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
StatechartLibrary Methods Table
Method ID Short Name (English) Description RTE
18A16402 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.
18A16403 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.

Note 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 Generate Documentation item on the shortcut menu of an .lvsc item, or statechart library, in a statechart project. This method also is similar to the File»Generate Documentation menu item in the Statechart Editor window.

Events

No Events for this class.

History

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

See Also