Difference between revisions of "Extensions.Flash.GetSignature"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetSignature | Returns the signature information of a block or a session | Term | Flash|OTX Flash exte...")
 
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetSignature'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetSignature | Returns the signature information of a block or a session | [[Term]] | [[Flash|OTX Flash extension]] | [[Security related terms]] | [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetSignature | Gets the signature information of a block or a session. | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Security related terms]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String GetSignature(FlashSession session, Integer security);
+
StringTerm Flash.GetSignature(FlashSessionTerm session, NumericTerm block, NumericTerm security);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetSignature''' term is the signature information of a block or a session.
+
The '''GetSignature''' term returns the signature information of a block or a session.
  
−
{{TermReturnValue| [[String]] | The signature information of a block or a session.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The signature information of a block or a session.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| FlashSession | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block containing the segment resides.}}
+
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}}
−
{{TableRowPropertie2| Block | [[Integer]] | [[Term]] | - | [0..1] | This element represents the number of the block whose signature shall be returned.}}
+
{{TableRowPropertie1| Block | [[Numeric]] | [[Term]] | - | [0..1] | This element represents the number of the block whose signature will be returned. If the '''<block>''' element is omitted, the signature of the flash session will be returned instead. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}}
−
{{TableRowPropertie1| Security | [[Integer]] | [[Term]] | - | [1] | This element defines the number of the security on which the term execution is based.}}
+
{{TableRowPropertie2| Security | [[Numeric]] | [[Term]] | - | [1] | This element defines the number of the security on which the term execution is based. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String result = GetSignature(flashSession, 0, 0);
+
/// Local Declarations
 +
 
 +
DiagCom.ComChannel ComChannel1;
 +
Flash.FlashSession FlashSession1;
 +
List<String> List1;
 +
String String1;
 +
 
 +
/// Flow
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
 +
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
 +
FlashSession1 = Flash.GetFlashSession(List1[2]);
 +
String1 = Flash.GetSignature(FlashSession1, 1, 0);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetValidity]] <br/>
+
<!--[[Extensions.Flash.GetSignature|GetSignature]] <br/>-->
−
[[GetChecksum]] <br/>
+
[[Extensions.Flash.GetValidity|GetValidity]] <br/>
−
[[GetSecurityMethod]]
+
[[Extensions.Flash.GetChecksum|GetChecksum]] <br/>
 +
[[Extensions.Flash.GetSecurityMethod|GetSecurityMethod]]<br/>
 +
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/>
 +
[[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Latest revision as of 02:23, 13 September 2019

Classification

Name GetSignature
Short Description Gets the signature information of a block or a session.
Class Term
Extension OTX Flash extension
Group Security related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm Flash.GetSignature(FlashSessionTerm session, NumericTerm block, NumericTerm security);

Description

The GetSignature term returns the signature information of a block or a session.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String The signature information of a block or a session.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represents the FlashSession in which the block resides.
Block Numeric Term - [0..1] This element represents the number of the block whose signature will be returned. If the <block> element is omitted, the signature of the flash session will be returned instead. Float values will be truncated.
Security Numeric Term - [1] This element defines the number of the security on which the term execution is based. Float values will be truncated.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
String String1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
String1 = Flash.GetSignature(FlashSession1, 1, 0);

See also

GetValidity
GetChecksum
GetSecurityMethod
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Flash.GetSignature&oldid=9748"