public interface IDataProvider
An interface for determining what features are available for a particular object(pin-power, temperature, etc). IDataProviders are anything that have information to share regardless of their positions in any particular hierarchy.
Modifier and Type | Method and Description |
---|---|
java.util.ArrayList<IData> |
getDataAtCurrentTime(java.lang.String feature)
This operation returns all of the data (as IData[*]) related to a particular feature for this provider at a specific time step.
|
java.util.ArrayList<java.lang.String> |
getFeatureList()
This operation returns the list of features available across all time steps (pin-power, temperature, etc).
|
java.util.ArrayList<java.lang.String> |
getFeaturesAtCurrentTime()
Returns the list of features at the current time.
|
int |
getNumberOfTimeSteps()
This operation returns the total number of time steps.
|
java.lang.String |
getSourceInfo()
This operation is a description of the source of information for this provider and its data.
|
java.util.ArrayList<java.lang.Double> |
getTimes()
Returns all the times in ascending order.
|
int |
getTimeStep(double time)
Returns the integer time based upon the time step.
|
java.lang.String |
getTimeUnits()
Returns the time units.
|
void |
setTime(double step)
This operation sets the current time step for which data should be retrieved.
|
java.util.ArrayList<java.lang.String> getFeatureList()
This operation returns the list of features available across all time steps (pin-power, temperature, etc).
The list of features.
int getNumberOfTimeSteps()
This operation returns the total number of time steps.
The number of time steps.
void setTime(double step)
This operation sets the current time step for which data should be retrieved. It is 0-indexed such that time step 0 is the initial state and time step 1 is the state after the first time step. This operation should be called to set the current time step before data is retrieved from the provider. The provider will always default to the initial state.
step
- The time step to set.
java.util.ArrayList<IData> getDataAtCurrentTime(java.lang.String feature)
This operation returns all of the data (as IData[*]) related to a particular feature for this provider at a specific time step.
This operation will return null if no data is available and such a situation will most likely signify an error.
feature
- The feature for the IData.
The returned IData.
java.lang.String getSourceInfo()
This operation is a description of the source of information for this provider and its data.
The source information.
java.util.ArrayList<java.lang.String> getFeaturesAtCurrentTime()
Returns the list of features at the current time.
The returned list of features at the current time step.
java.util.ArrayList<java.lang.Double> getTimes()
Returns all the times in ascending order.
An arraylist of times in order from least to greatest. This operation does not allow the user to change the order of this list.
int getTimeStep(double time)
Returns the integer time based upon the time step. Returns -1 if the time does not exist.
time
- java.lang.String getTimeUnits()
Returns the time units.
The time unit.