GEE_OperatorGroup Class Reference

A class to express operator timing information. More...

#include <gee_operator.h>

Inheritance diagram for GEE_OperatorGroup:

[legend]Collaboration diagram for GEE_OperatorGroup:

[legend]List of all members.

Public Types

• typedef std::map< GEE_OperatorTimer,
  VEE_RefPtr< GEE_Operator > > container
• typedef container::iterator iterator
• typedef std::list< VEE_RefPtr<
  GEE_Operator > > operatorList
• typedef operatorList::iterator listIter

Public Member Functions

• GEE_OperatorGroup ()
• ~GEE_OperatorGroup ()
• bool start (GEE_OperatorManager *, GEE_World *, const GEE_TimeStamp &)
• bool act (GEE_OperatorManager *, GEE_World *, const GEE_TimeStamp &)
• bool stop (GEE_OperatorManager *, GEE_World *, const GEE_TimeStamp &)
• void addOperator (VEE_RefPtr< GEE_Operator > &)
• void clearOperators ()
• bool read (GEE_Io *)
• bool write (GEE_Io *)
• const GEE_TimeStamp & offset () const
• void setOffset (const GEE_TimeStamp &offset)
• GEE_TimeStamp endTime ()

  Group end time in the host time system:.
  

• GEE_TimeStamp firstTime ()

  Returns the internal time of the first operator (not mapped into system time).
  

• void calculateEndTime ()
• double scale () const
• void setScale (double scale)
• GEE_id_t group () const
• void setGroup (GEE_id_t g)
• bool keepAlive ()
• void setKeepAlive (bool keep)
• uint operatorCount () const

Protected Member Functions

• void nextFrame (GEE_World *, const GEE_TimeStamp &)

  Calculates one step forward in local time coordinates.
  

Protected Attributes

• GEE_TimeStamp m_time

  Latest updated internal time.
  

• GEE_TimeStamp m_offset

  Timing offset in host time:.
  

• GEE_TimeStamp m_endTime

  End time in local time frame:.
  

• double m_scale

  Scales internal time to relative host time.
  

• uint m_frame
• GEE_id_t m_group

  The host group for hierarchical grouping.
  

• container m_operators
• iterator m_nextOperator
• operatorList m_currentOperators
• bool m_keepAlive

  Should we try to keep this group active even after its time has passed.
  

• bool m_running

Static Protected Attributes

• static bool m_debug = false

---

Detailed Description

A class to express operator timing information.

Each operator belongs to some group. The group has some timing scale (time stretch) and offset (beginning time). Thes two can be altered in any way (but both must be non-negative).

Author:

Tommi Ilmonen

---

Member Typedef Documentation

typedef std::map<GEE_OperatorTimer, VEE_RefPtr<GEE_Operator> > GEE_OperatorGroup::container

typedef container::iterator GEE_OperatorGroup::iterator

typedef std::list<VEE_RefPtr<GEE_Operator> > GEE_OperatorGroup::operatorList

typedef operatorList::iterator GEE_OperatorGroup::listIter

---

Constructor & Destructor Documentation

GEE_OperatorGroup::GEE_OperatorGroup (   )

GEE_OperatorGroup::~GEE_OperatorGroup (   )

---

Member Function Documentation

bool GEE_OperatorGroup::start (  GEE_OperatorManager *  , GEE_World *  , const GEE_TimeStamp &  )

bool GEE_OperatorGroup::act (  GEE_OperatorManager *  , GEE_World *  , const GEE_TimeStamp &  )

bool GEE_OperatorGroup::stop (  GEE_OperatorManager *  , GEE_World *  , const GEE_TimeStamp &  )

void GEE_OperatorGroup::addOperator (  VEE_RefPtr< GEE_Operator > &   )

void GEE_OperatorGroup::clearOperators (   )

bool GEE_OperatorGroup::read (  GEE_Io *   )

bool GEE_OperatorGroup::write (  GEE_Io *   )

const GEE_TimeStamp& GEE_OperatorGroup::offset (   )  const [inline]

void GEE_OperatorGroup::setOffset (  const GEE_TimeStamp &  offset  )  [inline]

GEE_TimeStamp GEE_OperatorGroup::endTime (   )  [inline]

Group end time in the host time system:.

GEE_TimeStamp GEE_OperatorGroup::firstTime (   )

Returns the internal time of the first operator (not mapped into system time).

void GEE_OperatorGroup::calculateEndTime (   )

double GEE_OperatorGroup::scale (   )  const [inline]

void GEE_OperatorGroup::setScale (  double  scale  )  [inline]

GEE_id_t GEE_OperatorGroup::group (   )  const [inline]

void GEE_OperatorGroup::setGroup (  GEE_id_t  g  )  [inline]

bool GEE_OperatorGroup::keepAlive (   )  [inline]

void GEE_OperatorGroup::setKeepAlive (  bool  keep  )  [inline]

uint GEE_OperatorGroup::operatorCount (   )  const [inline]

void GEE_OperatorGroup::nextFrame (  GEE_World *  , const GEE_TimeStamp &  )  [protected]

Calculates one step forward in local time coordinates.

---

Member Data Documentation

GEE_TimeStamp GEE_OperatorGroup::m_time [protected]

Latest updated internal time.

GEE_TimeStamp GEE_OperatorGroup::m_offset [protected]

Timing offset in host time:.

GEE_TimeStamp GEE_OperatorGroup::m_endTime [protected]

End time in local time frame:.

double GEE_OperatorGroup::m_scale [protected]

Scales internal time to relative host time.

uint GEE_OperatorGroup::m_frame [protected]

GEE_id_t GEE_OperatorGroup::m_group [protected]

The host group for hierarchical grouping.

container GEE_OperatorGroup::m_operators [protected]

iterator GEE_OperatorGroup::m_nextOperator [protected]

operatorList GEE_OperatorGroup::m_currentOperators [protected]

bool GEE_OperatorGroup::m_keepAlive [protected]

Should we try to keep this group active even after its time has passed.

bool GEE_OperatorGroup::m_running [protected]

bool GEE_OperatorGroup::m_debug = false [static, protected]

---

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

• gee_operator.h
• gee_operator.C

---