Difference between revisions of "Extensions.Flash.BlockIsValidForAudience"
Jump to navigation
Jump to search
m (Hb moved page BlockIsValidForAudience to Extensions.Flash.BlockIsValidForAudience: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''BlockIsValidForAudience '''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | BlockIsValidForAudience | Check if a block is valid for a given audience | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash block related terms]] | [[OutOfBoundsException]] | - }} | + | {{ClassificationActivity | BlockIsValidForAudience | Check if a block is valid for a given audience | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash block related terms]] | [[OutOfBoundsException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 11: | Line 11: | ||
The '''BlockIsValidForAudience''' term return true if and only if a block is valid for a given audience. | The '''BlockIsValidForAudience''' term return true if and only if a block is valid for a given audience. | ||
| − | {{TermReturnValue| [[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.}} |
== 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] | The Flash session in which the block is located.}} |
| − | {{TableRowPropertie2| Block | [[Integer]] | [[Term]] | - | [1] | The block number.}} | + | {{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The block number.}} |
| − | {{TableRowPropertie1| Aucience | [[Audience]] | [[Value]] | @Audience:SUPPLIER | - | This attribute defines which audience shall be used for the check.}} | + | {{TableRowPropertie1| Aucience | [[Extensions.Flash.Audience|Audience]] | [[Value]] | @Audience:SUPPLIER | - | This attribute defines which audience shall be used for the check.}} |
|} | |} | ||
| Line 35: | Line 35: | ||
== 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/> |
| − | [[GetType]] | + | [[Extensions.Flash.GetType|GetType]] |
Revision as of 07:55, 15 February 2016
Contents
Classification
| Name | BlockIsValidForAudience |
| Short Description | Check if a block is valid for a given audience |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash block related terms |
| Exceptions | OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm = Flash.BlockIsValidForAudience(FlashSessionTerm, IntegerTerm, Audience);Description
The BlockIsValidForAudience term return 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] | The Flash session in which the block is located. |
| Block | Integer | Term | - | [1] | The block number. |
| Aucience | Audience | Value | @Audience:SUPPLIER | - | This attribute defines which audience shall be used for the check. |
OTL Examples
DiagCom.ComChannel ComChannel1;
List<String> List1;
Flash.FlashSession FlashSession1;
Boolean Boolean1 = false;
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashSession1 = Flash.GetFlashSession(List1[0]);
Boolean1 = Flash.BlockIsValidForAudience(FlashSession1, 0, @Audiences:SUPPLIER);See also
GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
