Difference between revisions of "Extensions.Flash.GetNumberOfSegments"

From emotive
Jump to navigation Jump to search
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''GetNumberOfSegments'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''GetNumberOfSegments'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetNumberOfSegments | Specifies the number of data segments in a block | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash block related terms]] | [[Core.Actions.Throw.Exception.OutOfBoundsException|OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetNumberOfSegments | Gets the number of data segments in a block | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|OFlash block related terms]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
IntegerTerm = Flash.GetNumberOfSegments(FlashSessionTerm, IntegerTerm);
+
IntegerTerm Flash.GetNumberOfSegments(FlashSessionTerm session, NumericTerm block);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetNumberOfSegments''' term specifies the number of data segments in a return block. If there are no segments, the return value is zero, otherwise a positive number will be.
+
The '''GetNumberOfSegments''' term will return the number of data segments in a block. If no segments exist, the return value will be zero, otherwise it will be a positive number.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of data segments in a block.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of data segments in a block.}}
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block of interest resides.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block of interest resides.}}
−
{{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The number of the block from which the number of data segments to be accessed.}}
+
{{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element provides the number of the block from which the number of data segments will be retrieved. [[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;
 
List<String> List1;
 
List<String> List1;
−
Flash.FlashSession FlashSession1;
 
 
Integer Integer1;
 
Integer Integer1;
  
−
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
−
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
+
 
−
FlashSession1 = Flash.GetFlashSession(List1[0]);
+
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
 +
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
 +
FlashSession1 = Flash.GetFlashSession(List1[2]);
 
Integer1 = Flash.GetNumberOfSegments(FlashSession1, 1);
 
Integer1 = Flash.GetNumberOfSegments(FlashSession1, 1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
 +
<!--[[Extensions.Flash.GetNumberOfSegments|GetNumberOfSegments]] <br/>-->
 
[[Extensions.Flash.GetNumberOfOwnIdents|GetNumberOfOwnIdents]] <br/>
 
[[Extensions.Flash.GetNumberOfOwnIdents|GetNumberOfOwnIdents]] <br/>
 
[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>
 
[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>
Line 39: Line 44:
 
[[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/>
 
[[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/>
 
[[Extensions.Flash.GetType|GetType]] <br/>
 
[[Extensions.Flash.GetType|GetType]] <br/>
−
[[Extensions.Flash.BlockIsValidForAudience|BlockIsValidForAudience]]
+
[[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:16, 13 September 2019

Classification

Name GetNumberOfSegments
Short Description Gets the number of data segments in a block
Class Term
Extension OTX Flash extension
Group OFlash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm Flash.GetNumberOfSegments(FlashSessionTerm session, NumericTerm block);

Description

The GetNumberOfSegments term will return the number of data segments in a block. If no segments exist, the return value will be zero, otherwise it will be a positive number.

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
Integer The number of data segments in a block.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represents the FlashSession in which the block of interest resides.
Block Numeric Term - [1] This element provides the number of the block from which the number of data segments will be retrieved. Float values will be truncated.

OTL Examples

/// Local Declarations

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

/// Flow

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

See also

GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

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