com.monad.homerun.view
Class Snapshot

java.lang.Object
  extended by com.monad.homerun.view.Snapshot
All Implemented Interfaces:
java.io.Serializable

public class Snapshot
extends java.lang.Object
implements java.io.Serializable

A Snapshot is a collection of Scene data recorded at a particular time. Snapshots are used as data sources for captured - as opposed to live - Scene displays.

See Also:
Serialized Form

Constructor Summary
Snapshot(Scene scene)
           
 
Method Summary
 void addStatus(java.lang.String domain, java.lang.String objectName, java.lang.String modelName, ModelStatus stat)
          Adds a status value to the snapshot
 long getCaptureTime()
          Returns the time the snaphot was captured as millisecond system time
 java.lang.String getSceneName()
          Returns the name of the scene whose snapshot this is
 long getSceneTime()
          Returns the last modification time of the scene at the time the snaphot was captured as millisecond system time.
 ModelStatus getStatus(java.lang.String domain, java.lang.String objectName, java.lang.String modelName)
          Retrieves the status of an individual component
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Snapshot

public Snapshot(Scene scene)
Method Detail

addStatus

public void addStatus(java.lang.String domain,
                      java.lang.String objectName,
                      java.lang.String modelName,
                      ModelStatus stat)
Adds a status value to the snapshot

Parameters:
domain - domain of the component
objectName - object name of component
modelName - model name
stat - status object

getStatus

public ModelStatus getStatus(java.lang.String domain,
                             java.lang.String objectName,
                             java.lang.String modelName)
Retrieves the status of an individual component

Parameters:
domain -
objectName -
modelName -
Returns:
status the object's model status

getSceneName

public java.lang.String getSceneName()
Returns the name of the scene whose snapshot this is

Returns:
scene the name of the captured scene

getSceneTime

public long getSceneTime()
Returns the last modification time of the scene at the time the snaphot was captured as millisecond system time. This time is used to insure that snapshots can still be viewed (are invalid if scene time > capture time)

Returns:
time the capture time in milliseconds

getCaptureTime

public long getCaptureTime()
Returns the time the snaphot was captured as millisecond system time

Returns:
time the capture time in milliseconds


Copyright © 2006-2009 Richard Rodgers. All Rights Reserved.