Difference between revisions of "Extensions.Flash.GetNumberOfSecurities"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetNumberOfSecurities | Return the number of security information of a block or session | Term | Flash...")
 
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetNumberOfSecurities'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetNumberOfSecurities | Return the number of security information of a block or session | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash block related terms]] | [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetNumberOfSecurities | Gets the number of security information of a block or session | [[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;">
−
Integer GetNumberOfSecurities(FlashSession session);
+
IntegerTerm Flash.GetNumberOfSecurities(FlashSessionTerm session, NumericTerm block);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetNumberOfOwnIdents''' term return the number of security information of a block or session.
+
The '''GetNumberOfOwnIdents''' term will return the number of security information of a block or session.
  
−
{{TermReturnValue| [[Integer]] | The number of security information of a block or session.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of security information of a block or session.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Session | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession of interest.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' of interest.}}
−
{{TableRowPropertie1| Block | [[Integer]] | [[Term]] | - | [0..1] | This optional element is defined the block from which the number of security information to be retrieved. If the Element is omitted, the term indicates the number of securities that are defined in the Flash Session. }}
+
{{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [0..1] |This optional element defines the block from which the number of security information will be retrieved. If the '''<block>''' element is omitted, the term returns the number of securities defined for the flash session. [[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;">
−
Integer result = GetNumberOfSecurities(flashSession, 0);
+
/// 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.GetNumberOfSecurities(FlashSession1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetNumberOfSegments]] <br/>
+
[[Extensions.Flash.GetNumberOfSegments|GetNumberOfSegments]] <br/>
−
[[GetNumberOfOwnIdents]] <br/>
+
[[Extensions.Flash.GetNumberOfOwnIdents|GetNumberOfOwnIdents]] <br/>
−
[[GetLogicalBlockID]] <br/>
+
<!--[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>-->
−
[[GetCompressionEncryption]] <br/>
+
[[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/>
−
[[GetType]] <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:18, 13 September 2019

Classification

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

OTL Syntax

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

Description

The GetNumberOfOwnIdents term will return the number of security information of a block or 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
Integer The number of security information of a block or session.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represents the FlashSession of interest.
Block Numeric Term - [0..1] This optional element defines the block from which the number of security information will be retrieved. If the <block> element is omitted, the term returns the number of securities defined for the flash session. 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.GetNumberOfSecurities(FlashSession1);

See also

GetNumberOfSegments
GetNumberOfOwnIdents
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

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