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

Class Watcher

java.lang.Object

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

All Implemented Interfaces:

Comparable<Watcher>

public class Watcher
extends Object
implements Comparable<Watcher>

This class make up the data structure that maps variables to their associated agents. This will allow to notify all the agents if there is a change in the variable.

This class is based on a data structure described at POOL.for from the SPICE library.

Since:

4.11

Author:

T0281925

Constructor Summary

Constructors

Constructor and Description
Watcher(String var) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAgent(String agent) Add an agent to the list.
int	compareTo(Watcher w)
boolean	equals(Object obj)
List<String>	getAgents() Getter for the list of agents to be notified if the variable change.
String	getVarName() Getter for the variable name of the watcher.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Watcher

public Watcher(String var)
        throws IllegalArgumentException

Constructor.

Parameters:

var - variable to which we want to set a watcher

Throws:

IllegalArgumentException - if var is null or empty String

Method Detail

getVarName

public String getVarName()

Getter for the variable name of the watcher.

Returns:

the variable name of the watcher

getAgents

public List<String> getAgents()

Getter for the list of agents to be notified if the variable change.

Returns:

the list of agents associated to the variable

addAgent

public void addAgent(String agent)

Add an agent to the list.

Parameters:

agent - agent to be added to the list

compareTo

public int compareTo(Watcher w)

Specified by:

compareTo in interface Comparable<Watcher>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object