org.eclipse.tptp.platform.execution.client.agent
Interface ICollector

All Superinterfaces:

IAgent

public interface ICollector
extends IAgent

Collector is a type of agent primarily supporting data collection and agent control operations.

Provisional API: This API is subject to change in the next release.

Method Summary

void	cancel() Cancel the data collection process
int	getAgentState() Deprecated. since TPTP 4.0 See Agent Management document for Agent Event Management
boolean	isAgentRunning() Checks if agent is running and returns true/false
void	pause() Pause the data collection process
void	resume() Resume the data collection process
void	run() Start the data collection process
void	stop() Stop the data collection process

Methods inherited from interface org.eclipse.tptp.platform.execution.client.agent.IAgent

addAgentListener, addDataListener, addEventListener, getAgentListener, getAgentMetaData, getAgentMode, getName, getProcess, getSupportedInterfaces, isMonitored, receiveData, releaseAccess, releaseControl, removeEventListener, requestAccess, requestControl, sendCommand, sendCommand, sendData, setProcess, startMonitoring, startMonitoring, startMonitoring, stopMonitoring

Method Detail

run

void run()

Start the data collection process

pause

void pause()

Pause the data collection process

resume

void resume()

Resume the data collection process

cancel

void cancel()

Cancel the data collection process

stop

void stop()

Stop the data collection process

isAgentRunning

boolean isAgentRunning()

Checks if agent is running and returns true/false

getAgentState

int getAgentState()

Deprecated. since TPTP 4.0 See Agent Management document for Agent Event Management

Return the current state of the data collection process

Returns:

int