Logo
Telescience Resource Kit
TReK Python  5.4.0 ART
CounterParameterInfo Class Reference

Counter Parameter attributes. More...

Public Member Functions

def CounterParameterInfo ( PacketZoneType zone, int start_count=0, bool forward_count=True, int min_count=0, int max_count=0, int reset_value=0, None: int parent_start_bit=0 ->) -> def 
 Initialize Counter Parameter attributes. More...
 

Public Attributes

 zone
 Zone containing the counter parameter.
 
 start_count
 The beginning value of the counter.
 
 forward_count
 If true, the counter increments, false decrements.
 
 min_count
 The minimum count value. More...
 
 max_count
 The maximum count allowed. More...
 
 reset_value
 The value a counter resets to when the min or max count is reached.
 
 parent_start_bit
 The start bit of the parameter's parent (return only).
 

Static Public Attributes

 int
 The beginning value of the counter.
 
 bool
 If true, the counter increments, false decrements.
 

Detailed Description

Counter Parameter attributes.

See also
packet.Packet.set_counter_parameter()
packet.Packet.get_counter_parameter_info()

Constructor & Destructor Documentation

◆ CounterParameterInfo()

(zone : PacketZoneType 
start_count : int  
forward_count : bool  
min_count : int  
max_count : int  
reset_value : int  
parent_start_bit : int  
) -> None

Initialize Counter Parameter attributes.

Parameters
[in]zoneZone containing the counter parameter.
[in]start_countThe beginning value of the counter.
[in]forward_countIf true, the counter increments, false decrements.
[in]min_countThe minimum count value. For forward counter, used as next value when max reached.
[in]max_countThe maximum count allowed. For decrementing counter, used as next value when min reached.
[in]reset_valueThe value a counter resets to when the min or max count is reached.
[in]parent_start_bitThe start bit of the parameter's parent (return only).

Member Data Documentation

◆ max_count

The maximum count allowed.

For decrementing counter, used as next value when min reached.

◆ min_count

The minimum count value.

For forward counter, used as next value when max reached.