fr.cnes.sirius.patrius.bodies.bsp.spice

Class CounterArray

java.lang.Object

fr.cnes.sirius.patrius.bodies.bsp.spice.CounterArray

public class CounterArray
extends Object

This class class defines the object CounterArray and all the methods to manipulate it. These methods where originally defined in ZZCTR.for

A counter array consists of SpiceCommon.ctrsiz elements representing cascading counters. The fastest counter is at index 0, the slowest counter is at index CTRSIZ. At the start of counting all counter array elements are set to INTMIN. In the process of counting the fastest element is incremented by one. As with any cascading counters when the fastest counter reaches INTMAX it rolls back to INTMIN and the next counter is incremented by 1. When all counters reach INTMAX, Increment signals an error.

Since:

4.11

Author:

T0281925

Constructor Summary

Constructors

Constructor and Description
CounterArray(String type) Initializes the counter taking into account if it is a subsystem counter or an user counter. Makes the role of ZZCTRUIN and ZZCTRSIN from the SPICE library.

Method Summary

Modifier and Type	Method and Description
boolean	checkAndUpdate(CounterArray newCounter) Check and update, if needed, counter array.
boolean	equals(Object obj)
int	hashCode()
void	increment() Increment counter array.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CounterArray

public CounterArray(String type)
             throws PatriusException

Initializes the counter taking into account if it is a subsystem counter or an user counter.
Makes the role of ZZCTRUIN and ZZCTRSIN from the SPICE library.

Parameters:

type - Type of CounterArray

Throws:

PatriusException - if the CounterArray type is not recognized

Method Detail

increment

public void increment()
               throws PatriusException

Increment counter array.

Throws:

PatriusException - if the counter is not about to overflow

checkAndUpdate

public boolean checkAndUpdate(CounterArray newCounter)

Check and update, if needed, counter array.

Parameters:

newCounter - to compare with the current counter

Returns:

true if there has been an update

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object