org.arakhne.tinyMAS.core

Class DefaultProbe

java.lang.Object

org.arakhne.tinyMAS.core.DefaultProbe

All Implemented Interfaces:

Probe

Deprecated.

See "http://www.janus-project.org"

@Deprecated
 class DefaultProbe
extends Object
implements Probe

A probe permits to obtain information on agents.

A probe must not be invasive and the agent is able to ignore them (ie. to not provide information).

Author:

Stéphane GALLAND <galland@arakhne.org>, Nicolas GAUD <nicolas.gaud@utbm.fr>

Constructor Summary

Constructors

Constructor and Description
DefaultProbe(Agent agent) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearProbeValues() Deprecated. Remove all the values.
<T> T[]	getProbeArray(String probeName, Class<T> clazz) Deprecated. Replies a probed value.
boolean	getProbeBool(String probeName) Deprecated. Replies a probed value as boolean (if possible).
char	getProbeChar(String probeName) Deprecated. Replies a probed value as character (if possible).
AgentIdentifier	getProbedAgentId() Deprecated. Replies the identifier of the probed agent.
double	getProbeDouble(String probeName) Deprecated. Replies a probed value as double (if possible).
float	getProbeFloat(String probeName) Deprecated. Replies a probed value as float (if possible).
int	getProbeInt(String probeName) Deprecated. Replies a probed value as integer (if possible).
long	getProbeLong(String probeName) Deprecated. Replies a probed value as integer (if possible).
String[]	getProbeNames() Deprecated. Replies the names of the probed values inside the agent.
String	getProbeString(String probeName) Deprecated. Replies a probed value as string (if possible).
protected Object	getProbeValue(String probeName) Deprecated. Replies a probed value.
<T> T	getProbeValue(String probeName, Class<T> clazz) Deprecated. Replies a probed value.
boolean	hasProbeValue(String probeName) Deprecated. Replies if the specified probe value exists.
boolean	hasProbeValues() Deprecated. Replies if this probe contains a value.
boolean	isProbedAgentAlive() Deprecated. Replies if the agent is alive.
void	putProbeValue(String probeName, Object value) Deprecated. Store the value associated to a probe name.
void	removeProbeValue(String probeName) Deprecated. Remove a value from this probe.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProbe

DefaultProbe(Agent agent)

Deprecated.

Method Detail

getProbeNames

public final String[] getProbeNames()

Deprecated.

Replies the names of the probed values inside the agent.

Specified by:

getProbeNames in interface Probe

Returns:

the names of the probed values inside the agent.

getProbeValue

protected Object getProbeValue(String probeName)

Deprecated.

Replies a probed value.

Parameters:

probeName - is the name of the probed value

Returns:

the value

getProbeArray

public <T> T[] getProbeArray(String probeName,
                    Class<T> clazz)

Deprecated.

Replies a probed value.

This method permits to force the type of the value.

Specified by:

getProbeArray in interface Probe

Type Parameters:

T - is the type of the value to reply.

Parameters:

probeName - is the name of the probed value.

clazz - is the type of the expected value.

Returns:

the value or null

putProbeValue

public void putProbeValue(String probeName,
                 Object value)

Deprecated.

Store the value associated to a probe name.

This method is generally invoked from the agent.

Parameters:

probeName - is the name of the probed value.

value - is the value of the probe.

removeProbeValue

public void removeProbeValue(String probeName)

Deprecated.

Remove a value from this probe.

Parameters:

probeName - is the name of the probed value.

clearProbeValues

public void clearProbeValues()

Deprecated.

Remove all the values.

hasProbeValues

public boolean hasProbeValues()

Deprecated.

Replies if this probe contains a value.

Specified by:

hasProbeValues in interface Probe

Returns:

true if a probe value exists, otherwise false

getProbeValue

public final <T> T getProbeValue(String probeName,
                  Class<T> clazz)

Deprecated.

Replies a probed value.

This method permits to force the type of the value.

Specified by:

getProbeValue in interface Probe

Type Parameters:

T - is the type of the value to reply.

Parameters:

probeName - is the name of the probed value.

clazz - is the type of the expected value.

Returns:

the value or null

getProbeInt

public final int getProbeInt(String probeName)
                      throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as integer (if possible).

Specified by:

getProbeInt in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

getProbeLong

public final long getProbeLong(String probeName)
                        throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as integer (if possible).

Specified by:

getProbeLong in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

getProbeFloat

public final float getProbeFloat(String probeName)
                          throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as float (if possible).

Specified by:

getProbeFloat in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

getProbeDouble

public final double getProbeDouble(String probeName)
                            throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as double (if possible).

Specified by:

getProbeDouble in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

getProbeBool

public final boolean getProbeBool(String probeName)
                           throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as boolean (if possible).

Specified by:

getProbeBool in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

getProbeChar

public final char getProbeChar(String probeName)
                        throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as character (if possible).

Specified by:

getProbeChar in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

getProbeString

public final String getProbeString(String probeName)
                            throws ProbeValueNotDefinedException

Deprecated.

Replies a probed value as string (if possible).

Specified by:

getProbeString in interface Probe

Parameters:

probeName - is the name of the probed value.

Returns:

the value or null

Throws:

ProbeValueNotDefinedException

isProbedAgentAlive

public boolean isProbedAgentAlive()

Deprecated.

Replies if the agent is alive.

Specified by:

isProbedAgentAlive in interface Probe

Returns:

true if the agent associated to this probe is alive, otherwise false

getProbedAgentId

public AgentIdentifier getProbedAgentId()

Deprecated.

Replies the identifier of the probed agent.

Specified by:

getProbedAgentId in interface Probe

Returns:

the identifier of the probed agent.

hasProbeValue

public boolean hasProbeValue(String probeName)

Deprecated.

Replies if the specified probe value exists.

Specified by:

hasProbeValue in interface Probe

Parameters:

probeName - is the value name to test.

Returns:

true if a probe value exists, otherwise false