Logo
Telescience Resource Kit
TReK Python  5.4.0 ART
ChecksumParameterInfo Class Reference

Checksum Parameter attributes. More...

Public Member Functions

def ChecksumParameterInfo ( PacketZoneType zone, PacketChecksumPointType start_point, int start_offset, PacketChecksumPointType end_point, int end_offset, PacketChecksumType checksum_type, int polynomial=0x04C11DB7, int init_value=0xFFFFFFFF, int final_xor_value=0xFFFFFFFF, bool reflect_input=True, bool reflect_result=True -> None ) -> def 
 Class initializer. More...
 

Public Attributes

 zone
 The zone of the packet where the counter can be found.
 
 start_point
 The start point for the checksum. More...
 
 start_offset
 The offset from the specified start_point. More...
 
 end_point
 The end point for the checksum. More...
 
 end_offset
 The offset from the specified end_point. More...
 
 checksum_type
 The type of checksum to be performed. More...
 
 polynomial
 The polynomial to use for the CRC calculation. More...
 
 init_value
 The initial value to use for the CRC calculation. More...
 
 final_xor_value
 The final value to perform the exclusive or on the checksum. More...
 
 reflect_input
 Reflect the input (swap bit order). More...
 
 reflect_result
 Reflect the output (swap bit order). More...
 

Static Public Attributes

 int
 
 bool
 

Detailed Description

Checksum Parameter attributes.

See also
packet.Packet.set_checksum_parameter()
packet.Packet.get_checksum_parameter_info()

Constructor & Destructor Documentation

◆ ChecksumParameterInfo()

(zone : PacketZoneType 
start_point : PacketChecksumPointType 
start_offset : int 
end_point : PacketChecksumPointType 
end_offset : int 
checksum_type : PacketChecksumType 
polynomial : int  
init_value : int  
final_xor_value : int  
reflect_input : bool  
reflect_result : bool  
) -> None

Class initializer.

Parameters
[in]zoneThe zone of the packet where the counter can be found.
[in]start_pointThe start point for the checksum. Must be before the end_point.
[in]start_offsetThe offset from the specified start_point. Useful if the checksum does not include all of a 'zone'.
[in]end_pointThe end point for the checksum. Must be after the start_point.
[in]end_offsetThe offset from the specified end_point. Useful if the checksum does not include all of a 'zone'.
[in]checksum_typeThe type of checksum to be performed. The data type for the parameter must be compatible with the selected type.
[in]polynomialThe polynomial to use for the CRC calculation. Typically written as 0x12345678. Only used if type is CT_GENERIC_CRC32.
[in]init_valueThe initial value to use for the CRC calculation. Typically 0 or 0xffffffff. Only used if type is CT_GENERIC_CRC32.
[in]final_xor_valueThe final value to perform the exclusive or on the checksum. Typically 0 or 0xffffffff. Only used if type is CT_GENERIC_CRC32.
[in]reflect_inputReflect the input (swap bit order). Only used if type is CT_GENERIC_CRC32.
[in]reflect_resultReflect the output (swap bit order). Only used if type is CT_GENERIC_CRC32.

Member Data Documentation

◆ checksum_type

The type of checksum to be performed.

The data type for the parameter must be compatible with the selected type.

◆ end_offset

The offset from the specified end_point.

Useful if the checksum does not include all of a 'zone'.

◆ end_point

The end point for the checksum.

Must be after the start_point.

◆ final_xor_value

The final value to perform the exclusive or on the checksum.

Typically 0 or 0xffffffff. Only used if type is CT_GENERIC_CRC32.

◆ init_value

The initial value to use for the CRC calculation.

Typically 0 or 0xffffffff. Only used if type is CT_GENERIC_CRC32.

◆ polynomial

The polynomial to use for the CRC calculation.

Typically written as 0x12345678. Only used if type is CT_GENERIC_CRC32.

◆ reflect_input

Reflect the input (swap bit order).

Only used if type is CT_GENERIC_CRC32.

◆ reflect_result

Reflect the output (swap bit order).

Only used if type is CT_GENERIC_CRC32.

◆ start_offset

The offset from the specified start_point.

Useful if the checksum does not include all of a 'zone'.

◆ start_point

The start point for the checksum.

Must be before the end_point.