com.monad.homerun.store
Interface RecordingService

public interface RecordingService

RecordingService manages data recordings - which are time series of sampled data values, typically from a ScalarModel. The current implementation does not offer recording persistence.

Method Summary

boolean	addRecording(Recording recording) Adds a recording to the service
byte[]	getPlot(java.util.List<java.lang.String> recKeys, java.lang.String title, java.lang.String options) Obtains an image of a plot of one or more recordings
Recording	getRecording(java.lang.String recId) Obtains a recording by recording ID
boolean	isRecording(java.lang.String srcId) Determines whether a recording is active
boolean	removeRecording(java.lang.String recId) Removes a recordinf from the service managed set
void	resumeRecording(java.lang.String srcId) Continues a suspended recording
void	startRecording(java.lang.String srcId, java.lang.Object valueType, int frameRate) Starts a recording for a given source
void	stopRecording(java.lang.String srcId) Stops a currently open recording
boolean	updateRecording(Recording recording) Updates a recording in the service
void	updateRecording(java.lang.String srcId, Value value) Adds a new (sampled) value to a recording

Method Detail

getRecording

Recording getRecording(java.lang.String recId)

Obtains a recording by recording ID

Parameters:

recId - the recording identifier

Returns:

recording

addRecording

boolean addRecording(Recording recording)

Adds a recording to the service

Parameters:

recording - the recording to add

Returns:

true if recording added, else false

updateRecording

boolean updateRecording(Recording recording)

Updates a recording in the service

Parameters:

recording - the recording to update

Returns:

true if updated, else false

removeRecording

boolean removeRecording(java.lang.String recId)

Removes a recordinf from the service managed set

Parameters:

recId - the recording identifier

Returns:

true if removed

isRecording

boolean isRecording(java.lang.String srcId)

Determines whether a recording is active

Parameters:

srcId - identifier of recording source

Returns:

true if this source is being recorded

startRecording

void startRecording(java.lang.String srcId,
                    java.lang.Object valueType,
                    int frameRate)

Starts a recording for a given source

Parameters:

srcId - identifier of recording source

valueType - the data type of the source

frameRate - the interframe interval in seconds

resumeRecording

void resumeRecording(java.lang.String srcId)

Continues a suspended recording

Parameters:

srcId - identifier of recording source

updateRecording

void updateRecording(java.lang.String srcId,
                     Value value)

Adds a new (sampled) value to a recording

Parameters:

srcId - identifier of recording source

value - the data value

stopRecording

void stopRecording(java.lang.String srcId)

Stops a currently open recording

Parameters:

srcId - identifier of recording source

getPlot

byte[] getPlot(java.util.List<java.lang.String> recKeys,
               java.lang.String title,
               java.lang.String options)

Obtains an image of a plot of one or more recordings

Parameters:

recKeys - set of recording identifiers

title - title of plot

options - plotting options

Returns:

a plot image