org.kepler.data.datasource.dataturbine

Class DataTurbine

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.lib.Source

ptolemy.actor.lib.LimitedFiringSource

org.kepler.data.datasource.dataturbine.DataTurbine

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class DataTurbine
extends LimitedFiringSource

The DataTurbine actor retrieves and outputs data from an RBNB DataTurbine server. Sink mode Request has been tested beneath SDF, modes Monitor and Subscribe briefly in PN.

Author:

Derik Barseghian

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	actorModeInputParam Actor mode
Parameter	blockTimeoutParam The amount of time (ms) to wait for data to become available.
static java.lang.String	CHANNEL_NAMES_OUTPUT_PORT channelNames - This output port outputs all of the filtered (non-metric) channel names.
PortParameter	dataTurbineAddressInputParam The URL to the DataTurbine Server
PortParameter	durationPortParam The duration of the request.
PortParameter	outputChannelPortParam The name of the channel to output through the specifiedChannel output port
java.lang.String	outputRecOfArrays
Parameter	outputRecordOfArrays Format of output datapoint and timestamp pairs: Record of 2 Arrays, or an Array of X Records.
boolean	paddingOn
Parameter	referenceInputParam For Subscribe mode: Any of "newest", "oldest", "absolute", "next", or "previous".
static java.lang.String	SINKMODE_MONITOR
static java.lang.String	SINKMODE_REQUEST
static java.lang.String	SINKMODE_SUBSCRIBE
Parameter	sinkModeInputParam Sink mode.
PortParameter	startTimePortParam Start time for Request or Subscribe modes. seconds or Date: yyyy-MM-dd HH:mm:ss
Parameter	tryToPad Will attempt to identify and pad gappy data with pairs of timestamps and nils.
boolean	willPad padding is not always possible.
static java.lang.String	ZEROTIME

Fields inherited from class ptolemy.actor.lib.LimitedFiringSource

_firingCountLimit, _iterationCount, firingCountLimit

Fields inherited from class ptolemy.actor.lib.Source

_triggered, output, trigger

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
DataTurbine(CompositeEntity container, java.lang.String name) Construct a DataTurbine source with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) Reconfigure actor when certain attributes change.
java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
java.util.Vector<java.lang.Object>	doPadding(java.util.Vector<java.lang.Object> timeAndDataVector, java.lang.String chanTypeName)
java.util.Vector<java.lang.Object>	fillGaps(java.util.Vector<java.lang.Object> timeAndDataVector)
void	fire() Send the token in the value parameter to the output.
java.lang.String	getRBNBClientName() Get the name of this DataTurbine client.
java.lang.String	getServer() Get the server name and port string.
com.rbnb.sapi.ChannelMap	getUserChannelMap(java.lang.String[] requestedChannels) Return a channel map that contains only channels with duration >=0 and that were requested.
long	guessSamplingRate(java.util.Vector<java.lang.Object> timeAndDataVector)
boolean	openDataTurbine() Open connection to DataTurbine server.
void	outputChannelNames() Output the channel names through the CHANNEL_NAMES_OUTPUT_PORT as an ArrayToken.
void	outputData(com.rbnb.sapi.ChannelMap cmap) Push the data out the output ports.
void	outputNils(TypedIOPort port) Output nils for a given port.
java.util.Vector<java.lang.Object>	padGaps(long sampleInterval, int numMissing, java.util.Vector<java.lang.Object> timeAndDataVector)
void	preinitialize() Reset the stop requested boolean.
void	stop() The director told us to stop firing immediately.
void	wrapup() Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable().

Methods inherited from class ptolemy.actor.lib.LimitedFiringSource

initialize, postfire

Methods inherited from class ptolemy.actor.lib.Source

_customTypeConstraints, prefire

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

ZEROTIME

public static final java.lang.String ZEROTIME

See Also:

Constant Field Values

SINKMODE_MONITOR

public static final java.lang.String SINKMODE_MONITOR

See Also:

Constant Field Values

SINKMODE_REQUEST

public static final java.lang.String SINKMODE_REQUEST

See Also:

Constant Field Values

SINKMODE_SUBSCRIBE

public static final java.lang.String SINKMODE_SUBSCRIBE

See Also:

Constant Field Values

dataTurbineAddressInputParam

public PortParameter dataTurbineAddressInputParam

The URL to the DataTurbine Server

actorModeInputParam

public Parameter actorModeInputParam

Actor mode

outputChannelPortParam

public PortParameter outputChannelPortParam

The name of the channel to output through the specifiedChannel output port

blockTimeoutParam

public Parameter blockTimeoutParam

The amount of time (ms) to wait for data to become available. Use 0 for no delay or any negative number for an infinite delay.

sinkModeInputParam

public Parameter sinkModeInputParam

Sink mode.

• Request: Initiates a request for a specific time slice of data.
• Subscribe: Starts a continuous feed of data on the specified channels to this sink, for retrieval. Each block retrieved will be duration time units in length.
• Monitor: Similar to Subscribe, but allows for continuous frames of data without gaps.

startTimePortParam

public PortParameter startTimePortParam

Start time for Request or Subscribe modes. seconds or Date: yyyy-MM-dd HH:mm:ss

durationPortParam

public PortParameter durationPortParam

The duration of the request. Unit is seconds unless fetchByFrame is set.

CHANNEL_NAMES_OUTPUT_PORT

public static final java.lang.String CHANNEL_NAMES_OUTPUT_PORT

channelNames - This output port outputs all of the filtered (non-metric) channel names.

See Also:

Constant Field Values

referenceInputParam

public Parameter referenceInputParam

For Subscribe mode: Any of "newest", "oldest", "absolute", "next", or "previous".
For Request mode:

• "absolute" -- The start parameter is absolute time from midnight, Jan 1st, 1970 UTC.
• "newest" -- The start parameter is measured from the most recent data available in the server at the time this request is received. Note that for this case, the start parameter actually represents the end of the duration, and positive times proceed toward oldest data.
• "oldest" -- As "newest", but relative to the oldest data.
• "aligned" -- As "newest", but rather than per channel, this is relative to the newest for all of the channels.
• "after" -- A combination between "absolute" and "newest", this flag causes the server to return the newest data available after the specified start time. Unlike "newest", you do not have to request the data to find out that you already have it. Unlike "absolute", a gap may be inserted in the data to provide you with the freshest data.
• "modified" -- Similar to "after", but attempts to return a duration's worth of data in a contiguous block. If the data is not available after the start time, it will be taken from before the start time.
• "next" - gets the data that immediately follows the time range specified. This will skip over gaps.
• "previous" - get the data that immediately preceeds the time range specified. This will skip over gaps.

outputRecordOfArrays

public Parameter outputRecordOfArrays

Format of output datapoint and timestamp pairs: Record of 2 Arrays, or an Array of X Records.

tryToPad

public Parameter tryToPad

Will attempt to identify and pad gappy data with pairs of timestamps and nils. Need at least 2 samples to be able to pad.

outputRecOfArrays

public java.lang.String outputRecOfArrays

paddingOn

public boolean paddingOn

willPad

public boolean willPad

padding is not always possible.

Constructor Detail

DataTurbine

public DataTurbine(CompositeEntity container,
                   java.lang.String name)
            throws NameDuplicationException,
                   IllegalActionException

Construct a DataTurbine source with the given container and name.

Parameters:

name - The name of this actor.

Throws:

IllegalActionException - If the entity cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

fire

public void fire()
          throws IllegalActionException

Send the token in the value parameter to the output.

Specified by:

fire in interface Executable

Overrides:

fire in class Source

Throws:

IllegalActionException - If it is thrown by the send() method sending out the token.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Reset the stop requested boolean.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

stop

public void stop()

The director told us to stop firing immediately.

Specified by:

stop in interface Executable

Overrides:

stop in class AtomicActor<TypedIOPort>

getUserChannelMap

public com.rbnb.sapi.ChannelMap getUserChannelMap(java.lang.String[] requestedChannels)
                                           throws com.rbnb.sapi.SAPIException

Return a channel map that contains only channels with duration >=0 and that were requested.

Returns:

chanMap The ChannelMap.

Throws:

com.rbnb.sapi.SAPIException

getServer

public java.lang.String getServer()

Get the server name and port string.

Returns:

server URL

getRBNBClientName

public java.lang.String getRBNBClientName()

Get the name of this DataTurbine client.

Returns:

client name

outputChannelNames

public void outputChannelNames()

Output the channel names through the CHANNEL_NAMES_OUTPUT_PORT as an ArrayToken.

outputData

public void outputData(com.rbnb.sapi.ChannelMap cmap)
                throws IllegalActionException

Push the data out the output ports.

Parameters:

ChannelMap -

Throws:

IllegalActionException

doPadding

public java.util.Vector<java.lang.Object> doPadding(java.util.Vector<java.lang.Object> timeAndDataVector,
                                                    java.lang.String chanTypeName)

Parameters:

timeAndDataVector -

chanTypeName -

Returns:

fillGaps

public java.util.Vector<java.lang.Object> fillGaps(java.util.Vector<java.lang.Object> timeAndDataVector)

guessSamplingRate

public long guessSamplingRate(java.util.Vector<java.lang.Object> timeAndDataVector)

padGaps

public java.util.Vector<java.lang.Object> padGaps(long sampleInterval,
                                                  int numMissing,
                                                  java.util.Vector<java.lang.Object> timeAndDataVector)

outputNils

public void outputNils(TypedIOPort port)

Output nils for a given port.

Parameters:

TypedIOPort - port

openDataTurbine

public boolean openDataTurbine()
                        throws com.rbnb.sapi.SAPIException,
                               IllegalActionException

Open connection to DataTurbine server.

Throws:

com.rbnb.sapi.SAPIException

IllegalActionException

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Reconfigure actor when certain attributes change.

Overrides:

attributeChanged in class LimitedFiringSource

Parameters:

attribute - The changed Attribute.

Throws:

IllegalActionException

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor into the specified workspace.

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

wrapup

public void wrapup()
            throws IllegalActionException

Description copied from class: AtomicActor

Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable(). Derived classes override this method to define operations to be performed exactly once at the end of a complete execution of an application. It typically closes files, displays final results, etc.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.