Difference between revisions of "SHIPHarbour:XVars:Var"

From Serious Documentation
Jump to: navigation, search
(Created page with "== Source File == SHIPHarbour_XVars.proto == Description == <onlyinclude>Directly relates to a SHIPBridge linkset definable in [...")
 
(value)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
  
 
== Description ==
 
== Description ==
<onlyinclude>Directly relates to a [[Protocol:SHIPBridge|SHIPBridge]] [[SHIP:Node:linkset|linkset]] definable in [[SHIP:Sail_Overview|Sail]].</onlyinclude>
+
<onlyinclude>Directly relates to a [[Protocol:SHIPBridge|SHIPBridge]] [[SHIP:Node:linkvar|linkvar]] definable in [[SHIP:Sail_Overview|Sail]].</onlyinclude>
  
 
== Types ==
 
== Types ==
Line 34: Line 34:
 
* [[SHIPHarbour:DataTypes:StringValue|xString]] - {{:SHIPHarbour:DataTypes:StringValue}}
 
* [[SHIPHarbour:DataTypes:StringValue|xString]] - {{:SHIPHarbour:DataTypes:StringValue}}
 
* [[SHIPHarbour:DataTypes:BytesValue|xBytes]] - {{:SHIPHarbour:DataTypes:BytesValue}}
 
* [[SHIPHarbour:DataTypes:BytesValue|xBytes]] - {{:SHIPHarbour:DataTypes:BytesValue}}
 
[[Category:SHIPHarbour]]
 

Latest revision as of 17:00, 31 July 2017

Source File

SHIPHarbour_XVars.proto

Description

Directly relates to a SHIPBridge linkvar definable in Sail.

Types

Attribute

sub

Boolean indicating whether or not anything for this variable should be transmitted.

push

Boolean indicating whether or not new values for this variable should be transmitted automatically.

Message Fields

attr

An Attribute describing how this value should be updated.

id

A unique id within a Set assigned by the Serious Integrated module.

type

A Type indicating how to interpret the value field.

value

Holds exactly one of the following types:

  • xbool - Fixed-length binary value.
  • xInt - Variable-length encoded signed 64-bit integer value.
  • xFloat - Fixed-length 32-bit floating point value.
  • xDouble - Fixed-length encoded 64-bit floating point value.
  • xString - Arbitrary-length UTF-8 and/or 7-bit ASCII text values.
  • xBytes - Arbitrary-length byte values.