io.sarl.api.probing
Interface ProbeService
All Superinterfaces:
org.arakhne.afc.services.IService
All Known Implementing Classes:
AbstractProbeService, AsynchronousProbeService, SynchronousProbeService
@org.eclipse.xtext.xbase.lib.XbaseGenerated
interface ProbeService
implements org.arakhne.afc.services.IService
This service provides probing mechanisms.
Maven Group Identifier:
io.sarl.sdk
Maven Artifact Identifier:
api.probing
Since:
0.12
Property Summary
Modifier and type Property and description
java.util.Collection<E> probes
Replies all the probes.
Action Summary
Modifier and type Action and description
abstract java.util.Collection<E> getProbes
Replies all the probes.
abstract Probe<T> probe(SarlName,Class<T>,[String])
Create a probe.
abstract Probe<T> probe(String,Class<T>,[String])
Create a probe.
abstract Probe<T> probe(URI,Class<T>,[String])
Create a probe.
abstract void releaseAllProbes
Release all the probes.
abstract void sync
Force the synchronization of the probes.
Property Details
probes
val probes : java.util.Collection<E>
Replies all the probes.

This property is an alias for the action: getProbes

Returns:
the iterable on probes
Action Details
getProbes
def getProbes : java.util.Collection<E>
Replies all the probes.
Returns:
the iterable on probes
probe(SarlName,Class<T>,[String])
def probe(SarlName,Class<T>,[String]) : Probe<T>
 with T
Create a probe.

If a probe with the same name name exists, a composed probe with the probe name is created with the probes as composite.
Parameters:
valueName - the probed element.
valueType - the expected type of the value.
probeName - is the optional name of the probe.
probe(String,Class<T>,[String])
def probe(String,Class<T>,[String]) : Probe<T>
 with T
Create a probe.

If a probe with the same name name exists, a composed probe with the probe name is created with the probes as composite.
Parameters:
valueName - the probed element.
valueType - the expected type of the value.
probeName - is the optional name of the probe.
probe(URI,Class<T>,[String])
def probe(URI,Class<T>,[String]) : Probe<T>
 with T
Create a probe.

If a probe with the same name name exists, a composed probe with the probe name is created with the probes as composite.
Parameters:
valueName - the probed element.
valueType - the expected type of the value.
probeName - is the optional name of the probe.
releaseAllProbes
def releaseAllProbes
Release all the probes.
sync
def sync
Force the synchronization of the probes.