Difference between revisions of "Extensions.Persistence.Save"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''Save'''}}[[Category:Persistence]]
 
{{DISPLAYTITLE:OTX '''Save'''}}[[Category:Persistence]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | Save | UPDATING... | [[Action]] | [[Extensions.Persistence|OTX Persistence extension]] | UPDATING... | [[Core.Actions.Throw.Exception.PersistenceException|PersistenceException]] | UPDATING... }}
+
{{ClassificationActivity | Save| Saves the value of an OTX variable | [[Action]] | [[Extensions.Persistence|OTX Persistence extension]] | [[Extensions.Persistence#Actions|Persistence Relates Actions]] | [[Extensions.Persistence.PersistenceSaveException|PersistenceSaveException]]| [[Extensions.Persistence.PersistenceChk001|Persistence_Chk001]] }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.CloseComChannel(ComChannelVariable);
+
Persistence.Save(Variable);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
The '''Save''' activity saves the value of an OTX variable of a valid data type to the storage.
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
 
{{ComChannelMemoryUsageNote}}
 
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
 
-->
 
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| Value| - | [[Variable]] | - | [1..1] |The Variable to be stored persistently. The variable shall have a valid data type, which is checked by a new checker rule.}}
 
|}
 
|}
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.ComChannel myComCannel;
+
Float Float1;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
Persistence.Save(Float1);
// ...
 
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
 
<!--[[Extensions.Persistence.Save|Save]]-->
 
<!--[[Extensions.Persistence.Save|Save]]-->
 
[[Extensions.Persistence.Load|Load]]
 
[[Extensions.Persistence.Load|Load]]

Revision as of 11:01, 1 October 2018

Classification

Name Save
Short Description Saves the value of an OTX variable
Class Action
Extension OTX Persistence extension
Group Persistence Relates Actions
Exceptions PersistenceSaveException
Checker Rules Persistence_Chk001
Standard Compliant Yes

OTL Syntax

Persistence.Save(Variable);

Description

The Save activity saves the value of an OTX variable of a valid data type to the storage.

Properties

Name Data Type Class Default Cardinality Description
Value - Variable - [1..1] The Variable to be stored persistently. The variable shall have a valid data type, which is checked by a new checker rule.

OTL Examples

Float Float1;

/// Flow

Persistence.Save(Float1);

See also

Load