Kaim::PathEventList Class Reference

Kaim::PathEventList Class Reference

#include <patheventlist.h>

Class Description

PathEventList aggregates all PathEvents and PathEventIntervals in a PathValidityInterval.

+ Examples:

Functions

 PathEventList ()
 
 ~PathEventList ()
 
void Clear ()
 
KyUInt32 GetPathEventCount () const
 
KyUInt32 GetPathEventIntervalCount () const
 
PathEventGetPathEvent (KyUInt32 eventIdx)
 
PathEventGetFirstPathEvent ()
 
PathEventGetLastPathEvent ()
 
const PathEventGetPathEvent (KyUInt32 eventIdx) const
 
const PathEventGetFirstPathEvent () const
 
const PathEventGetLastPathEvent () const
 
KyUInt32 GetIntervalIdxBeforeEvent (KyUInt32 eventIdx) const
 Return the index of interval ending at the event of index eventIdx. More...
 
KyUInt32 GetIntervalIdxAfterEvent (KyUInt32 eventIdx) const
 Return the index of interval starting at the event of index eventIdx. More...
 
const NavTag * GetNavTagOnIntervalBeforeEvent (KyUInt32 eventIdx) const
 Returns a pointer to the NavTag lying under interval ending at the event of index eventIdx. More...
 
const NavTag * GetNavTagOnIntervalAfterEvent (KyUInt32 eventIdx) const
 Returns a pointer to the NavTag lying under the interval starting at the event of index eventIdx. More...
 
KyUInt32 GetStartPathEventIdxOfInterval (KyUInt32 intervalIdx) const
 
KyUInt32 GetEndPathEventIdxOfInterval (KyUInt32 intervalIdx) const
 
const PathEventGetStartPathEventOfInterval (KyUInt32 intervalIdx) const
 
const PathEventGetEndPathEventOfInterval (KyUInt32 intervalIdx) const
 
const NavTag * GetNavTagOfEventInterval (KyUInt32 intervalIdx) const
 

For internal use only

KyArray< PathEventInterval, MemStat_Bot > m_pathEventIntervalArray
 

Member Function Documentation

KyUInt32 Kaim::PathEventList::GetIntervalIdxAfterEvent ( KyUInt32  eventIdx) const
inline

Return the index of interval starting at the event of index eventIdx.

Precondition
eventIdx is different from GetPathEventIntervalCount() - 1, the index of the last event.
KyUInt32 Kaim::PathEventList::GetIntervalIdxBeforeEvent ( KyUInt32  eventIdx) const
inline

Return the index of interval ending at the event of index eventIdx.

Precondition
eventIdx is different from 0, the index of the first event.
const NavTag * Kaim::PathEventList::GetNavTagOnIntervalAfterEvent ( KyUInt32  eventIdx) const
inline

Returns a pointer to the NavTag lying under the interval starting at the event of index eventIdx.

Precondition
eventIdx is different from GetPathEventIntervalCount() - 1, the index of the last event.
+ Examples:
const NavTag * Kaim::PathEventList::GetNavTagOnIntervalBeforeEvent ( KyUInt32  eventIdx) const
inline

Returns a pointer to the NavTag lying under interval ending at the event of index eventIdx.

Precondition
eventIdx is different from 0, the index of the first event.

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