tfjava::Frame Class Reference

List of all members.

Public Member Functions
	Frame (String frameID, long maxStorageTime)
TransformStorage	getData (long time, Frame sourceFrame)
String	getFrameID ()
Set< Frame >	getParentFrames ()
TimeCache	getTimeCache (Frame sourceFrame)
boolean	insertData (TransformStorage newData)
Private Attributes
String	frameID
long	maxStorageTime
HashMap< Frame, TimeCache >	parentMap

---

Detailed Description

Transformation frame, containing references to all parent frames and corresponding time caches.

Author:

Sjoerd van den Dries

Version:

Feb 28, 2011

Definition at line 42 of file Frame.java.

---

Constructor & Destructor Documentation

tfjava::Frame::Frame	(	String	frameID,
		long	maxStorageTime
	)			[inline]

Class constructor.

Definition at line 54 of file Frame.java.

---

Member Function Documentation

TransformStorage tfjava::Frame::getData	(	long	time,
		Frame	sourceFrame
	)			[inline]

Retrieves the direct transformation from sourceFrame to this frame, at time point time.

Parameter sourceFrame must be a direct parent of this frame. The transformation is looked up in the appropriate time cache, if available. If necessary, inter- or extrapolation is used to return a transformation of the given point in time.

Definition at line 89 of file Frame.java.

String tfjava::Frame::getFrameID

(

)

[inline]

Returns the ID of this frame.

Definition at line 102 of file Frame.java.

Set<Frame> tfjava::Frame::getParentFrames

(

)

[inline]

Returns a set containing references to all parent frames of this frame.

Definition at line 116 of file Frame.java.

TimeCache tfjava::Frame::getTimeCache

(

Frame

sourceFrame

)

[inline]

Returns the time cache containing the transformations from sourceFrame to this frame.

Definition at line 109 of file Frame.java.

boolean tfjava::Frame::insertData

(

TransformStorage

newData

)

[inline]

Inserts transform newData into the appropriate time cache (based on frame of newData).

Definition at line 63 of file Frame.java.

---

Member Data Documentation

String tfjava::Frame::frameID [private]

ID of this frame.

Definition at line 45 of file Frame.java.

long tfjava::Frame::maxStorageTime [private]

Maximum storage time of time caches in nanoseconds.

Definition at line 49 of file Frame.java.

HashMap<Frame, TimeCache> tfjava::Frame::parentMap [private]

Map containing parent frames of this frame with corresponding time caches.

Definition at line 47 of file Frame.java.

---

The documentation for this class was generated from the following file:

• Frame.java