Field
Summary
Represents a SOME/IP Field.
- Methods
- Properties
Structure
- class Field
- get_bit_position() int32
Retrieves the bit position of the current parameter.
- Returns
Bit position of the parameter.
- Return type
- get_length() int32
Retrieves the length of the current parameter.
- Returns
Length of the parameter.
- Return type
- set_length(p0: int32)
Sets the length of the parameter data.
- Parameters
p0 (
int32) – Desired length.
- set_payload_offset(payloadOffset: int32)
Sets the offset of the payload.
- Parameters
payloadOffset (
int32) – Payload offset.
- arrays
List of arrays that are part of the parameter. A parameter can have a list of arrays, each o them defined by a dimension, a number of elements, the field_size (if it’s dynamic) and a type of elements. To determine the size of the array a length parameter, which counts the bytes of the array, added during the serialization process.
- Type
- base_type
- String used in the Fibex database to specify the basic data type.
It can be one of the following values: bool uint8 uint8 uint16 uint32 uint64 int8 int16 int32 int64 float32 float64 string struct union typedef
- Type
- basic_partial_network
Extract from the database a list of the basic partial network vehicle state
- bit_length
Static length of the declared data type. It represents the bit length used to encode the parameter. It could be, for example, a byte coded parameter but coded only on
2bits.- Type
- compu_methods
Represent the method to calculate the transmitted value to the physical representation.
- Type
- e2e
Configuration of End-to-End Communication Protection
- Type
- enumeration_elements
Dictionary containing enum values and keys if the parameter is an enumeration object.
- Type
Dictionary[str,str]
- functional_partial_network
Extract from the database a list of the functional partial network vehicle state on
- getter_id
Identifier of the getter associated with the field. A getter is a request/response call that allows read access to a field.
- Type
- getter_timing
Represents the timing manufacturer extension of the getter.
- identifier
It is the first
16bitsof the Sequence Identifier field. This file is used to help match echo requests with the associated reply. It identifies the first byte of the data that is stored in the data portion of the segment.- Type
- is_high_low_bit_order
Trueif the bytes are stored in big endian format.Falseif they are stored using little endian encoding.- Type
boolor None
- length_field_size
The optional size of a leading length parameter of a data type.
- Type
uint32or None
- manufacturer_extension
The manufacturer extensions.
- max_bit_length
Dynamic length of the declared datatype in the datatype-declaration. It represents the maximum bit length used to encode the parameter.
- Type
uint32or None
- members
List of members or parts of the parameter if its type is complex. Each member is a parameter and, as such, it contains the same properties the parameter objects have.
- min_bit_length
Dynamic length of the declared datatype in the datatype-declaration. It represents the mininum bit length used to encode the parameter.
- Type
uint32or None
- notifier_id
Identifier of the notifier associated with the field. A notifier is an element in charge of sending out event messages every time the value of a field changes.
- Type
- notifier_timing
Represents the timing manufacturer extension of the notifier.
- service_parent
Service to which the Field belongs.
- Type
- setter_id
Identifier of the setter associated with the field. A setter is a request/response call that allows to write access to a field.
- Type
- setter_timing
Represents the timing manufacturer extension of the setter.
- string_encoding
- Specifying the data encoding if not defined by the data type.
It can be one of the following values:
utf-8,utf-16,iso-8859-1,iso-8859-2,windows-1252.
- Type
- string_termination
Specifying the termination used. It can be one of the following value: NONE, ZERO
- Type
charor None