Difference between revisions of "Core.Terms.SubByteField"

From emotive
Jump to navigation Jump to search
m (Hb moved page SubByteField to Core.Terms.SubByteField: #3153)
Line 1: Line 1:
[[Category:Core]]
+
{{DISPLAYTITLE:OTX '''SubByteField'''}}[[Category:Core]]
 
== Classification ==
 
== Classification ==
 
{{ClassificationActivity | SubByteField | Return of a part ByteFields | [[Term]] | [[Core|OTX Core library]] | [[ByteField operations]] | - | - }}
 
{{ClassificationActivity | SubByteField | Return of a part ByteFields | [[Term]] | [[Core|OTX Core library]] | [[ByteField operations]] | - | - }}
Line 13: Line 13:
 
{{Important|Please keep in mind that this [[TermActivity]] in the form of an activity exists and no text can be entered. According to the respective [[ActionNode]] can further properties are added.}}
 
{{Important|Please keep in mind that this [[TermActivity]] in the form of an activity exists and no text can be entered. According to the respective [[ActionNode]] can further properties are added.}}
  
{{TermReturnValue| [[ByteField]] | Returns of a number of bytes from the ByteField}}
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | Returns of a number of bytes from the ByteField}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ByteFieldTerm | [[ByteField]] | [[Term]] | - | [1] | Source ByteField}}
+
{{TableRowPropertie1| ByteFieldTerm | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | Source ByteField}}
{{TableRowPropertie2| Index | [[Integer]] | [[Term]] | - | [1] | Position (zero based) in the ByteField from which the bytes should be returned}}
+
{{TableRowPropertie2| Index | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | Position (zero based) in the ByteField from which the bytes should be returned}}
{{TableRowPropertie1| Count | [[Integer]] | [[Term]] | - | [1] | Number of bytes that should be returned.}}
+
{{TableRowPropertie1| Count | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | Number of bytes that should be returned.}}
 
|}
 
|}
  
Line 31: Line 31:
  
 
== See also ==
 
== See also ==
[[BitwiseAnd]] <br/>
+
[[Core.Terms.BitwiseAnd|BitwiseAnd]] <br/>
[[BitwiseOr]] <br/>
+
[[Core.Terms.BitwiseOr|BitwiseOr]] <br/>
[[BitwiseXor]] <br/>
+
[[Core.Terms.BitwiseXor|BitwiseXor]] <br/>
[[BitwiseNot]] <br/>
+
[[Core.Terms.BitwiseNot|BitwiseNot]] <br/>
[[ByteFieldGetSize]] <br/>
+
[[Core.Terms.ByteFieldGetSize|ByteFieldGetSize]] <br/>
[[GetBit]]
+
[[Core.Terms.GetBit|GetBit]]

Revision as of 04:00, 5 February 2016

Classification

Name SubByteField
Short Description Return of a part ByteFields
Class Term
Extension OTX Core library
Group ByteField operations
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ByteFieldTerm = ByteField.SubByteField(ByteFieldTerm, IntegerTerm, IntegerTerm);

Description

SubByteField is a term, which starting returns a number of bytes as a result from a position in the ByteField.

Exclamation.png Important: Please keep in mind that this TermActivity in the form of an activity exists and no text can be entered. According to the respective ActionNode can further properties are added.

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
ByteField Returns of a number of bytes from the ByteField

Properties

Name Data Type Class Default Cardinality Description
ByteFieldTerm ByteField Term - [1] Source ByteField
Index Integer Term - [1] Position (zero based) in the ByteField from which the bytes should be returned
Count Integer Term - [1] Number of bytes that should be returned.

OTL Examples

ByteField result;
result = ByteField.SubByteField(&1234, 1, 1);
//Returns result = &34

See also

BitwiseAnd
BitwiseOr
BitwiseXor
BitwiseNot
ByteFieldGetSize
GetBit