org.eclipse.tptp.platform.execution.datacollection
Interface IVariableProvider

public interface IVariableProvider

The Variable Provider interface provides the interface for setting and retrieving the values of Variables that the Agent exports

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

Method Summary

VariableGroup	getRootVariableGroup() Get the root variable group (full configuration) alongwith all the sub groups and variables
Variable	getVariable(int varid) Get the value of a specific variable
VariableGroup	getVariableGroup(int id) Get the Variable Group alongwith the sub groups and variables
Variable[]	getVariables() Get all variables
Variable[]	getVariablesById(int[] varids) Get the Variables values of the variable list supplied as parameter
Variable	getVariableValue() Get single variable value
Variable[]	getVariableValues() Get multiple variables
void	setVariableGroup(VariableGroup variableGroup) Sets the Variable Group values
void	setVariableValue(Variable variable) Set single variable value
void	setVariableValues(Variable[] variables) Set multiple variables

Method Detail

getRootVariableGroup

VariableGroup getRootVariableGroup()

Get the root variable group (full configuration) alongwith all the sub groups and variables

getVariableGroup

VariableGroup getVariableGroup(int id)

Get the Variable Group alongwith the sub groups and variables

Parameters:

id -

setVariableGroup

void setVariableGroup(VariableGroup variableGroup)

Sets the Variable Group values

Parameters:

variableGroup -

getVariables

Variable[] getVariables()

Get all variables

Returns:

Variable[]

getVariable

Variable getVariable(int varid)

Get the value of a specific variable

Parameters:

varid -

Returns:

Variable

getVariablesById

Variable[] getVariablesById(int[] varids)

Get the Variables values of the variable list supplied as parameter

Parameters:

varids -

Returns:

Variable[]

getVariableValues

Variable[] getVariableValues()

Get multiple variables

Returns:

Variable[]

setVariableValues

void setVariableValues(Variable[] variables)

Set multiple variables

Parameters:

variables -

getVariableValue

Variable getVariableValue()

Get single variable value

Returns:

Variable

setVariableValue

void setVariableValue(Variable variable)

Set single variable value

Parameters:

variable -