Difference between revisions of "Extensions.Flash.GetType"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetType | Specifies the type of the block | Term | OTX Flash extension | Flash block related...")
 
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetType'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetType | Specifies the type of the block | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash block related terms]] | [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetType | Gets the type of the block | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash block 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 GetType(FlashSession session, Integer block);
+
StringTerm Flash.GetType(FlashSessionTerm session, NumericTerm block);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetType''' term returns the type of the block.
+
The '''GetType''' term returns the type of a block. The type information indicates whether a block is used for data or for program code.
  
−
{{TermReturnValue| [[String]] | The type of the block.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The type of the block.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Session | [[FlashSession]] | [[Term]] | - | [1] | The Flash session in which the block is located.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}}
−
{{TableRowPropertie1| Block | [[Integer]] | [[Term]] | - | [1] | The block number.}}
+
{{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block number. [[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 = GetType(flashSession, 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.GetType(FlashSession1, 0);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetNumberOfSegments]] <br/>
+
[[Extensions.Flash.GetNumberOfSegments|GetNumberOfSegments]] <br/>
−
[[GetNumberOfOwnIdents]] <br/>
+
[[Extensions.Flash.GetNumberOfOwnIdents|GetNumberOfOwnIdents]] <br/>
−
[[GetNumberOfSecurities]] <br/>
+
[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>
−
[[GetLogicalBlockID]] <br/>
+
[[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/>
−
[[GetCompressionEncryption]] <br/>
+
[[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/>
−
[[BlockIsValidForAudience]]
+
<!--[[Extensions.Flash.GetType|GetType]] <br/>-->
 +
[[Extensions.Flash.BlockIsValidForAudience|BlockIsValidForAudience]]<br/>
 +
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]]<br/>
 +
[[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Latest revision as of 02:20, 13 September 2019

Classification

Name GetType
Short Description Gets the type of the block
Class Term
Extension OTX Flash extension
Group Flash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm Flash.GetType(FlashSessionTerm session, NumericTerm block);

Description

The GetType term returns the type of a block. The type information indicates whether a block is used for data or for program code.

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 type of the block.

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 - [1] This element represents the block number. 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.GetType(FlashSession1, 0);

See also

GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

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