OpenTracker

An Open Architecture for Reconfigurable Tracking based on XML | Contact

ot::RefNode Class Reference

#include <RefNode.h>

Inheritance diagram for ot::RefNode:

Inheritance graph
[legend]
Collaboration diagram for ot::RefNode:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~RefNode ()
NodegetReferenced ()
virtual void onEventGenerated (Event &event, Node &generator)
virtual int isEventGenerator ()
virtual int isEventQueue ()
virtual EventgetEvent (unsigned int index=0)
virtual EventgetEventNearTime (double time)
virtual unsigned int getSize ()
virtual int isTimeDependend ()
virtual EventgetEventAtTime (double time)

Protected Member Functions

 RefNode (Node *ref)

Protected Attributes

Nodereference

Friends

class ConfigurationParser

Detailed Description

Definition at line 81 of file RefNode.h.


Constructor & Destructor Documentation

ot::RefNode::RefNode ( Node ref  )  [inline, protected]

basic constructor.

Definition at line 91 of file RefNode.h.

virtual ot::RefNode::~RefNode (  )  [inline, virtual]

basic destructor.

Definition at line 102 of file RefNode.h.


Member Function Documentation

virtual Event& ot::RefNode::getEvent ( unsigned int  index = 0  )  [inline, virtual]

returns a stored event by index.

The index starts with 0 for the latest event and goes back in time with increasing index.

Parameters:
index index of the desired event, if no index is given the latest is returned.
Returns:
reference to the value of the event.

Reimplemented from ot::Node.

Definition at line 163 of file RefNode.h.

virtual Event& ot::RefNode::getEventAtTime ( double  time  )  [inline, virtual]

returns the event of the time dependend function at a given point in time.

Parameters:
time point in time in milliseconds since 1.1.1970
Returns:
reference to the event value

Reimplemented from ot::Node.

Definition at line 203 of file RefNode.h.

virtual Event& ot::RefNode::getEventNearTime ( double  time  )  [inline, virtual]

returns the event closest to a given point in time.

Parameters:
time the point in time in milliseconds since 1.1.1970
Returns:
reference to the value of the event.

Reimplemented from ot::Node.

Definition at line 171 of file RefNode.h.

Node* ot::RefNode::getReferenced (  )  [inline]

returns the referenced node

Returns:
pointer to the referenced node.

Definition at line 110 of file RefNode.h.

virtual unsigned int ot::RefNode::getSize (  )  [inline, virtual]

returns the number of stored events.

Returns:
number of stored events.

Reimplemented from ot::Node.

Definition at line 178 of file RefNode.h.

virtual int ot::RefNode::isEventGenerator (  )  [inline, virtual]

tests for EventGenerator interface being implemented.

This has to be overriden in classes that subclass EventGenerator. Due to inheritance constraints it cannot be done automatically.

Returns:
a pointer to the EventGenerator interface, or NULL if it is not implemented

Reimplemented from ot::Node.

Definition at line 138 of file RefNode.h.

virtual int ot::RefNode::isEventQueue (  )  [inline, virtual]

tests for EventQueue interface being present.

This has to be overriden in classes that subclass EventQueue. See isEventGenerator for details.

Returns:
a pointer to the EventQueue interface, or NULL if it is not implemented.

Reimplemented from ot::Node.

Definition at line 153 of file RefNode.h.

virtual int ot::RefNode::isTimeDependend (  )  [inline, virtual]

tests for TimeDependend interface being present.

This has to be overriden in classes that subclass TimeDependend. See isEventGenerator for details.

Returns:
a pointer to the TimeDependend interface, or NULL if it is not implemented.

Reimplemented from ot::Node.

Definition at line 193 of file RefNode.h.

virtual void ot::RefNode::onEventGenerated ( Event event,
Node generator 
) [inline, virtual]

this method notifies the object that a new event was generated.

It is called by an EventGenerator.

Parameters:
event reference to the new event. Do not change the event values, make a copy and change that !
generator reference to the EventGenerator object that notified the EventObserver.

Reimplemented from ot::Node.

Definition at line 125 of file RefNode.h.


Friends And Related Function Documentation

friend class ConfigurationParser [friend]

Reimplemented from ot::Node.

Definition at line 209 of file RefNode.h.


Member Data Documentation

pointer to the referenced node

Definition at line 86 of file RefNode.h.


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

copyright (c) 2006 Graz University of Technology