com.agenarisk.api.model

Class VariableObservation

java.lang.Object

com.agenarisk.api.model.Observation

com.agenarisk.api.model.VariableObservation

All Implemented Interfaces:

Storable

public class VariableObservation
extends Observation

VariableObservation class is a view of a node variable observation, valid at the time of resolution and not maintained.

Author:

Eugene Dementiev

Nested Class Summary

Nested classes/interfaces inherited from class com.agenarisk.api.model.Observation

Observation.Field

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VariableObservation(uk.co.agena.minerva.model.scenario.Observation logicObservation, DataSet dataSet, Node node) Constructor for VariableObservation.

Method Summary

Modifier and Type	Method and Description
String	getVariableName() Returns the name of the Variable associated with this Observation.
double	getVariableValue() Returns the value of this VariableObservation as a single double or zero if no value is set.
org.json.JSONObject	toJson() Creates a JSONObject representation of this Observation.

Methods inherited from class com.agenarisk.api.model.Observation

getDataSet, getEntries, getLogicObservation, getNode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableObservation

protected VariableObservation(uk.co.agena.minerva.model.scenario.Observation logicObservation,
                              DataSet dataSet,
                              Node node)
                       throws ObservationException

Constructor for VariableObservation.

Parameters:

logicObservation - Logic observation associated with this VariableObservation

dataSet - DataSet that contains this VariableObservation

node - observed Node

Throws:

ObservationException - entries are empty or not provided or if the logicObservation is not for a variable

Method Detail

getVariableName

public String getVariableName()

Returns the name of the Variable associated with this Observation.

Returns:

variable name

toJson

public org.json.JSONObject toJson()

Creates a JSONObject representation of this Observation.

Specified by:

toJson in interface Storable

Overrides:

toJson in class Observation

Returns:

JSONObject equivalent of this Observation

getVariableValue

public double getVariableValue()

Returns the value of this VariableObservation as a single double or zero if no value is set.

Returns:

value of this VariableObservation