com.tibco.cep.runtime.model.element

Interface PropertyAtomDouble

public interface PropertyAtomDouble

Property that contains one double.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
double	getDouble() Gets the current value of this property.
double	getDouble(long time) Gets the value that property had at the given time.
double	getDoubleAtIdx(int idx) Gets the value of this property at the given history index.
boolean	setDouble(double value) Sets the current value of this PropertyAtom.
boolean	setDouble(double value, long time) Sets the value of this PropertyAtom with a given time.

Method Detail

getDouble

double getDouble()

Gets the current value of this property.

Returns:

the current value of this property.

Since:

2.0.0

getDouble

double getDouble(long time)

Gets the value that property had at the given time.

Parameters:

time - a time expressed in number of milliseconds since the epoch.

Returns:

a double value.

Throws:

PropertyException - if the value at the given time is unknown.

Since:

2.0.0

setDouble

boolean setDouble(double value)

Sets the current value of this PropertyAtom.

Parameters:

value - the value to set

Returns:

true if a new entry was added in the history for this value.

Since:

2.0.0

See Also:

Property#getHistoryPolicy()

setDouble

boolean setDouble(double value,
                long time)

Sets the value of this PropertyAtom with a given time.

Parameters:

value - the value to set.

time - the time to associate with the value.

Returns:

true if a new entry was added in the history for this value.

Since:

2.0.0

See Also:

Property#getHistoryPolicy()

getDoubleAtIdx

double getDoubleAtIdx(int idx)

Gets the value of this property at the given history index.

Parameters:

idx - index in the history of this property.

Returns:

the value of this property at the given index.

Throws:

PropertyException - if the index is invalid.

Since:

2.0.0

See Also:

Property#getHistoryPolicy(), Property#getHistorySize()