Muscle Java API: muscle::core::ConduitEntrance< T extends Serializable > Class Reference

muscle::core::ConduitEntrance< T extends Serializable > Class Reference

List of all members.


Public Member Functions

 ConduitEntrance (ConduitEntranceController< T > controller, Timestamp origin, Distance timeStep)
void setDt (Distance dt)
void send (T data)
void send (T data, Timestamp currentTime)
void send (T data, Timestamp currentTime, Timestamp next)
void send (Observation< T > obs)
void close ()
String toString ()

Protected Attributes

Timestamp nextTime
Distance dt

Detailed Description

A ConduitEntrance adds data to a conduit. It has a send() interface with which it can send data messages. To make use of dynamic temporal scales, a timestamp may be given with a piece of data, and if possible also a next timestamp, being the next timestamp at which a piece of data will be sent.

Author:
Joris Borgdorff

Constructor & Destructor Documentation

muscle::core::ConduitEntrance< T extends Serializable >::ConduitEntrance ( ConduitEntranceController< T >  controller,
Timestamp  origin,
Distance  timeStep 
) [inline]

Member Function Documentation

void muscle::core::ConduitEntrance< T extends Serializable >::setDt ( Distance  dt  )  [inline]

Sets the timestep between messages.

void muscle::core::ConduitEntrance< T extends Serializable >::send ( T  data  )  [inline]

Send a piece of data. This assumes that the current timestep and the next follow statically from the temporal scale. It is a non-blocking call, meaning that the function returns almost immediately, no matter when the message is actually sent. To make this possible, the data is copied before its sent, so that the submodel may make use of it and modify it without affecting the data sent. It is not necessary to make a copy of the data inside the submodel before sending.

void muscle::core::ConduitEntrance< T extends Serializable >::send ( T  data,
Timestamp  currentTime 
) [inline]

Send a piece of data at the current timestep. This assumes that the next timestep follows statically from the temporal scale.

See also:
send(T)

void muscle::core::ConduitEntrance< T extends Serializable >::send ( T  data,
Timestamp  currentTime,
Timestamp  next 
) [inline]

Send a piece of data at the current timestep, also mentioning when the next piece of data will be sent.

See also:
send(T)

void muscle::core::ConduitEntrance< T extends Serializable >::send ( Observation< T >  obs  )  [inline]

Send an observation with data at the current timestep, also mentioning when the next piece of message will be sent.

See also:
send(T)

void muscle::core::ConduitEntrance< T extends Serializable >::close (  )  [inline]

Indicate that no more messages will be sent over the current conduit.

String muscle::core::ConduitEntrance< T extends Serializable >::toString (  )  [inline]

Member Data Documentation

Timestamp muscle::core::ConduitEntrance< T extends Serializable >::nextTime [protected]

Distance muscle::core::ConduitEntrance< T extends Serializable >::dt [protected]

Generated on Thu Oct 18 14:28:28 2012 for Muscle Java API by  doxygen 1.5.6