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

Class PoolSpice

java.lang.Object

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

public final class PoolSpice
extends Object

This class class reproduces the necessary routines of the pool.for file in original Spice library.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static boolean	checkPoolStateCounter(CounterArray c) Check and update the POOL state counter tracked by a caller (user) routine.
static boolean	checkUpdates(String agent) Indicate whether or not any watched kernel variables that have a specified agent on their notification list have been updated.
static boolean	checkUpdatesIfCounterUpdate(CounterArray c, String agent) Determine whether or not any of the POOL variables that are to be watched and have AGENT on their distribution list have been updated, but do the full watcher check only if the POOL state counter has changed.
static void	clpool() Clears the pool of kernel variables maintained by the kernel POOL subsystem.
static List<Integer>	getIntVals(String var) Return the integer value of a kernel variable from the kernel pool.
static List<String>	getStrVals(String var) Return the character value of a kernel variable from the kernel pool.
static void	init() This routine initializes the data structures needed for maintaining the kernel pool.
static void	setWatch(String agent, int nnames, String[] names) Add a name to the list of agents to notify whenever a member of a list of kernel variables is updated.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()

This routine initializes the data structures needed for maintaining the kernel pool.

clpool

public static void clpool()
                   throws PatriusException

Clears the pool of kernel variables maintained by the kernel POOL subsystem. All the variables in the pool are deleted. However, all watcher information is retained.

Each watched variable will be regarded as having been updated. Any agent associated with that variable will have a notice posted for it indicating that its watched variable has been updated.

Inspired by the CLPOOL routine in pool.for

Throws:

PatriusException - if the counter is not about to overflow

setWatch

public static void setWatch(String agent,
                            int nnames,
                            String[] names)
                     throws PatriusException

Add a name to the list of agents to notify whenever a member of a list of kernel variables is updated.

Inspired by SWPOOL in the SPICE library.

Parameters:

agent - The name of an agent to be notified after updates

nnames - The number of variables to associate with AGENT

names - Variable names whose update causes the notice

Throws:

PatriusException - if there is a problem incrementing the counter or the number of agents is too large

checkUpdates

public static boolean checkUpdates(String agent)

Indicate whether or not any watched kernel variables that have a specified agent on their notification list have been updated.

Inspired by CVPOOL of the SPICE library.

Parameters:

agent - Name of the agent to check for notices

Returns:

true if variables for AGENT have been updated

getStrVals

public static List<String> getStrVals(String var)
                               throws PatriusException

Return the character value of a kernel variable from the kernel pool.

Inspired by GCPOOL and STPOOL from the SPICE library. Doing th job for both.

Parameters:

var - Name of the variable whose value is to be returned

Returns:

the values associated with NAME

Throws:

PatriusException - if there is a problem in the initialization process

getIntVals

public static List<Integer> getIntVals(String var)
                                throws PatriusException

Return the integer value of a kernel variable from the kernel pool.

Inspired by GIPOOL from the SPICE library.

Parameters:

var - name of the variable whose values are to be returned

Returns:

the array of values associated with NAME. Any numeric value having non-zero fractional part is rounded to the closest integer.

Throws:

PatriusException - if there is a problem in the initialization process

checkPoolStateCounter

public static boolean checkPoolStateCounter(CounterArray c)

Check and update the POOL state counter tracked by a caller (user) routine.

Translation of ZZPCTRCK from the Spice library

Parameters:

c - State counter to check

Returns:

flag indicating if input counter was updated

checkUpdatesIfCounterUpdate

public static boolean checkUpdatesIfCounterUpdate(CounterArray c,
                                                  String agent)

Determine whether or not any of the POOL variables that are to be watched and have AGENT on their distribution list have been updated, but do the full watcher check only if the POOL state counter has changed.

Translation of ZZCVPOOL from the Spice Library

Parameters:

c - POOL state counter tracked by the caller

agent - name of the agent (routine) that need acess to the kernel pool

Returns:

logical flag that will be set to true if the variables in the kernel pool that are required by AGENT have been updated since the last call to CVPOOL