Difference between revisions of "Extensions.Flash.GetSignature"
Jump to navigation
Jump to search
| (2 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | StringTerm | + | StringTerm Flash.GetSignature(FlashSessionTerm session, NumericTerm block, NumericTerm security); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 17: | Line 17: | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}} | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}} | ||
| − | {{TableRowPropertie1| Block | [[Numeric]] | [[Term]] | - | [0..1] | This element represents the number of the block whose signature | + | {{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.}} |
| − | {{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 | + | {{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.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
Flash.FlashSession FlashSession1; | Flash.FlashSession FlashSession1; | ||
Latest revision as of 02:23, 13 September 2019
Contents
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.
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
