Jump to content

Template:VIServerProperty: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
mNo edit summary
Line 45: Line 45:
{{#if: {{{remoteallowed|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Remote access allowed</b></td><td>{{{remoteallowed}}}</td></tr>|}}
{{#if: {{{remoteallowed|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Remote access allowed</b></td><td>{{{remoteallowed}}}</td></tr>|}}
{{#if: {{{settablewhenrunning|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Settable when the VI is running</b></td><td>{{{settablewhenrunning}}}</td></tr>|}}
{{#if: {{{settablewhenrunning|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Settable when the VI is running</b></td><td>{{{settablewhenrunning}}}</td></tr>|}}
|}
|}</includeonly>
</includeonly>
<noinclude>
<noinclude>
{{underconstruction}}
 
== Usage ==
== Usage ==


Line 58: Line 57:
<nowiki>
<nowiki>
{{VIServerProperty
{{VIServerProperty
| classid=
| classid =
| propertyid=
| propertyid =
| scope=
| scope =
| dataname=
| dataname =
| shortname=
| shortname =
| longname=
| longname =
| datatypeimage=
| datatypeimage =
| datatype=
| datatype =
| propertynodeimage=
| propertynodeimage =
| availableinrealtime=
| availableinrealtime =
| availableinruntime=
| availableinruntime =
| availablewithcontrolvis=
| availablewithcontrolvis =
| availablewithglobalvis=
| availablewithglobalvis =
| availablewithpolyvis=
| availablewithpolyvis =
| availablewithstricttypedefs=
| availablewithstricttypedefs =
| loadsbd=
| loadsbd =
| loadsfp=
| loadsfp =
| mustwait=
| mustwait =
| needsauthentication=
| needsauthentication =
| permissions=
| permissions =
| remoteallowed=
| remoteallowed =
| settablewhenrunning=
| settablewhenrunning =
|}}
|}}
</nowiki>
</nowiki>
Line 91: Line 90:
! Default
! Default
|-
|-
| <code>{{{1}}}</code>
| <code>classid</code>
| The Class ID of a class in the [[VI Server Class Hierarchy]].
| The Class ID of a class in the [[VI Server Class Hierarchy]].
| <code></code>
| <code></code>
|-
|-
| <code>{{{2}}}</code>
| <code>propertyid</code>
| The Property ID of a property owned by the class defined by the Class ID {{{1}}}.
| The Property ID of the property owned by the class defined by the Class ID {{{classid}}}.
| <code></code>
|-
| <code>scope</code>
| The scope of the property as either {basic, script, private, deprecated}.
| <code></code>
|-
| <code>dataname</code>
| The data name of the property.
| <code></code>
|-
| <code>shortname</code>
| The short name of the property.
| <code></code>
|-
| <code>longname</code>
| The long name of the property.
| <code></code>
|-
| <code>datatypeimage</code>
| The filename to the wiki image for the data type terminal for the property.
| <code></code>
|-
| <code>datatype</code>
| The data type of the property.
| <code></code>
|-
| <code>propertynodeimage</code>
| The filename to the wiki image for the property node for the property.
| <code></code>
|-
| <code>availableinrealtime</code>
| The value for "Available in Real-Time Operating System".
| <code></code>
|-
| <code>availableinrealtime</code>
| The value for "Available in Real-Time Operating System".
| <code></code>
|-
| <code>availableinruntime</code>
| The value for "Available in Run-Time Engine".
| <code></code>
|-
| <code>availablewithcontrolvis</code>
| The value for "Available with control VIs".
| <code></code>
|-
| <code>availablewithglobalvis</code>
| The value for "Available with global VIs".
| <code></code>
|-
| <code>availablewithpolyvis</code>
| The value for "Available with polymorphic VIs".
| <code></code>
|-
| <code>availablewithstricttypedefs</code>
| The value for "Available with strict type definitions".
| <code></code>
|-
| <code>loadsbd</code>
| The value for "Loads the block diagram into memory".
| <code></code>
|-
| <code>loadsfp</code>
| The value for "Loads the front panel into memory".
| <code></code>
|-
| <code>mustwait</code>
| The value for "Must wait until user interface is idle".
| <code></code>
|-
| <code>needsauthentication</code>
| The value for "Need to authenticate before use".
| <code></code>
|-
| <code>permissions</code>
| The value for "Permissions".
| <code></code>
|-
| <code>remoteallowed</code>
| The value for "Remote access allowed".
| <code></code>
|-
| <code>settablewhenrunning</code>
| The value for "Settable when the VI is running".
| <code></code>
| <code></code>
|}
|}


'''Example'''
===Example===
 
<code>
<code>
<nowiki>
<nowiki>
{{VIServerProperty|classid=36|propertyid=632A813}}
{{VIServerProperty| classid = 36
| propertyid = 632A813
| scope = script
| dataname = UID
| shortname = UID
| longname = UID
| datatypeimage = I32.png
| datatype = I32
| propertynodeimage = GObject-UID.png
| availableinrealtime = Yes
| availableinruntime = Yes
| loadsbd = No
| loadsfp = No
| needsauthentication = No
| permissions = Read Only
| remoteallowed = Yes
| settablewhenrunning = No
}}
</nowiki>
</nowiki>
</code>
</code>
 
===Result===
<blockquote style="float: left;">
<blockquote style="float: left;">
{{VIServerProperty| classid = 36
{{VIServerProperty| classid = 36

Revision as of 02:29, 16 September 2019


Usage

Use this template is to create the Property Information table in VI Server property pages.

Syntax is as follows:

{{VIServerProperty | classid = | propertyid = | scope = | dataname = | shortname = | longname = | datatypeimage = | datatype = | propertynodeimage = | availableinrealtime = | availableinruntime = | availablewithcontrolvis = | availablewithglobalvis = | availablewithpolyvis = | availablewithstricttypedefs = | loadsbd = | loadsfp = | mustwait = | needsauthentication = | permissions = | remoteallowed = | settablewhenrunning = |}}

where:

Parameter Description Default
classid The Class ID of a class in the VI Server Class Hierarchy.
propertyid The Property ID of the property owned by the class defined by the Class ID {{{classid}}}.
scope The scope of the property as either {basic, script, private, deprecated}.
dataname The data name of the property.
shortname The short name of the property.
longname The long name of the property.
datatypeimage The filename to the wiki image for the data type terminal for the property.
datatype The data type of the property.
propertynodeimage The filename to the wiki image for the property node for the property.
availableinrealtime The value for "Available in Real-Time Operating System".
availableinrealtime The value for "Available in Real-Time Operating System".
availableinruntime The value for "Available in Run-Time Engine".
availablewithcontrolvis The value for "Available with control VIs".
availablewithglobalvis The value for "Available with global VIs".
availablewithpolyvis The value for "Available with polymorphic VIs".
availablewithstricttypedefs The value for "Available with strict type definitions".
loadsbd The value for "Loads the block diagram into memory".
loadsfp The value for "Loads the front panel into memory".
mustwait The value for "Must wait until user interface is idle".
needsauthentication The value for "Need to authenticate before use".
permissions The value for "Permissions".
remoteallowed The value for "Remote access allowed".
settablewhenrunning The value for "Settable when the VI is running".

Example

{{VIServerProperty| classid = 36 | propertyid = 632A813 | scope = script | dataname = UID | shortname = UID | longname = UID | datatypeimage = I32.png | datatype = I32 | propertynodeimage = GObject-UID.png | availableinrealtime = Yes | availableinruntime = Yes | loadsbd = No | loadsfp = No | needsauthentication = No | permissions = Read Only | remoteallowed = Yes | settablewhenrunning = No }}

Result



VI Server Property Information
Property ID 632A813
Scope VI Scripting
Data Name UID
Short Name* UID
Long Name* UID
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 36
Owning Class Name GObject Class
Data Type I32 data type

I32

Property Node UID
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Need to authenticate before useNo
PermissionsRead Only
Remote access allowedYes
Settable when the VI is runningNo


Retrieved from "https://labviewwiki.org/w/index.php?title=Template:VIServerProperty&oldid=10019"