Difference between revisions of "Extensions.Flash.BlockIsValidForAudience"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''BlockIsValidForAudience '''}}[[Category:Flash]] | {{DISPLAYTITLE: '''BlockIsValidForAudience '''}}[[Category:Flash]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | BlockIsValidForAudience | | + | {{ClassificationActivity | BlockIsValidForAudience | Checks whether a block is valid for a given audience or not.| [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash 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;"> | ||
| − | BooleanTerm = Flash.BlockIsValidForAudience(FlashSessionTerm, | + | BooleanTerm = Flash.BlockIsValidForAudience(FlashSessionTerm, NumericTerm, AudienceTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''BlockIsValidForAudience''' term | + | The '''BlockIsValidForAudience''' term returns '''true''' if and only if a block is valid for a given audience. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Return true if a block is valid for a given audience.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Return true if a block is valid for a given audience.}} | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}} |
| − | {{TableRowPropertie2| Block | [[ | + | {{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block number. Float values shall be truncated..}} |
| − | {{TableRowPropertie1| Aucience | [[Extensions.Flash.Audience|Audience]] | [[ | + | {{TableRowPropertie1| Aucience | [[Extensions.Flash.Audience|Audience]] | [[Term]] | @Audience:SUPPLIER | [1]| This attribute defines which '''audience'' shall be used for the check.}} |
|} | |} | ||
| Line 24: | Line 24: | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| + | Flash.FlashSession FlashSession1; | ||
List<String> List1; | List<String> List1; | ||
| − | |||
Boolean Boolean1 = false; | Boolean Boolean1 = false; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| − | List1 = Flash.GetListOfValidFlashSessions(@ | + | |
| − | FlashSession1 = Flash.GetFlashSession(List1[ | + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false); |
| − | Boolean1 = Flash.BlockIsValidForAudience(FlashSession1, | + | List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD); |
| + | FlashSession1 = Flash.GetFlashSession(List1[2]); | ||
| + | Boolean1 = Flash.BlockIsValidForAudience(FlashSession1, 1, @Audience:DEVELOPMENT); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 40: | Line 42: | ||
[[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/> | [[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/> | ||
[[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/> | [[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/> | ||
| − | [[Extensions.Flash.GetType|GetType]] | + | [[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/> | ||
Revision as of 03:26, 17 October 2018
Contents
Classification
| Name | BlockIsValidForAudience |
| Short Description | Checks whether a block is valid for a given audience or not. |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash block related terms |
| Exceptions | OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm = Flash.BlockIsValidForAudience(FlashSessionTerm, NumericTerm, AudienceTerm);Description
The BlockIsValidForAudience term returns true if and only if a block is valid for a given audience.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Boolean | Return true if a block is valid for a given audience. |
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 shall be truncated.. |
| Aucience | Audience | Term | @Audience:SUPPLIER | [1] | This attribute defines which 'audience shall be used for the check. |
OTL Examples
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
Boolean Boolean1 = false;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Boolean1 = Flash.BlockIsValidForAudience(FlashSession1, 1, @Audience:DEVELOPMENT);See also
GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
GetListOfValidFlashSessions
GetFlashSession
GetComChannel
