Logo
Telescience Resource Kit
TReK Python  5.4.0 ART
IdentifierInfo Class Reference

Identifier parameter attributes. More...

Public Member Functions

def IdentifierInfo ( PacketZoneType zone=PacketZoneType.HEADER_ZONE, IdentifierType id_type=IdentifierType.FIXED_VALUE_IDENTIFIER, bool has_default=False, int default=0, bool has_expected=False, int expected=0, None: int parent_start_bit=0 ->) -> def 
 Class initializer. More...
 

Public Attributes

 zone
 The zone containing the length parameter.
 
 id_type
 The type of identifier.
 
 has_default
 If has_default_value. More...
 
 default
 Only valid if has_default_value=true.
 
 has_expected
 If true, the expected_value is valid.
 
 expected
 Only valid if has_expected_value=true.
 
 parent_start_bit
 The start bit of the parameter's parent (return only).
 

Static Public Attributes

 PacketZoneType
 The zone containing the length parameter.
 
 IdentifierType
 The type of identifier.
 
 bool
 If has_default_value. More...
 
 int
 Only valid if has_default_value=true. More...
 

Detailed Description

Identifier parameter attributes.

See also
packet.Packet.add_identifier()
packet.Packet.get_identifier_info()

Constructor & Destructor Documentation

◆ IdentifierInfo()

(zone : PacketZoneType  
id_type : IdentifierType  
has_default : bool  
default : int  
has_expected : bool  
expected : int  
parent_start_bit : int  
) -> None

Class initializer.

Parameters
[in]zoneThe zone containing the length parameter.
[in]id_typeThe type of identifier.
[in]has_defaultIf has_default_value. If true, the default_value is valid.
[in]defaultOnly valid if has_default_value=true.
[in]has_expectedIf true, the expected_value is valid.
[in]expectedOnly valid if has_expected_value=true.
[in]parent_start_bitThe start bit of the parameter's parent (return only).

Member Data Documentation

◆ bool

static

If has_default_value.

If true, the expected_value is valid.

If true, the default_value is valid.

◆ has_default

If has_default_value.

If true, the default_value is valid.

◆ int

static

Only valid if has_default_value=true.

The start bit of the parameter's parent (return only).

Only valid if has_expected_value=true.