COPASI API  4.40.278
CMathEventQueue::CKey Class Reference

#include <CMathEventQueue.h>

Public Member Functions

 CKey ()
 
 CKey (const C_FLOAT64 &executionTime, const bool &equality, const size_t &cascadingLevel)
 
 CKey (const CKey &src)
 
const C_FLOAT64getExecutionTime () const
 
bool operator< (const CKey &rhs) const
 
 ~CKey ()
 

Private Attributes

size_t mCascadingLevel
 
bool mEquality
 
C_FLOAT64 mExecutionTime
 

Friends

std::ostream & operator<< (std::ostream &os, const CKey &o)
 

Constructor & Destructor Documentation

◆ CKey() [1/3]

CMathEventQueue::CKey::CKey ( )

Default constructor

◆ CKey() [2/3]

CMathEventQueue::CKey::CKey ( const CKey src)

Copy constructor

Parameters
constCKey & src

◆ CKey() [3/3]

CMathEventQueue::CKey::CKey ( const C_FLOAT64 executionTime,
const bool &  equality,
const size_t &  cascadingLevel 
)

Specific constructor

Parameters
constC_FLOAT64 & executionTime
constbool & equality
constsize_t & cascadingLevel

◆ ~CKey()

CMathEventQueue::CKey::~CKey ( )

Destructor

Member Function Documentation

◆ getExecutionTime()

const C_FLOAT64& CMathEventQueue::CKey::getExecutionTime ( ) const
inline

Retrieve the execution time.

Returns
const C_FLOAT64 & executionTime

References mExecutionTime.

◆ operator<()

bool CMathEventQueue::CKey::operator< ( const CKey rhs) const

A less than sort operator for sorting the entries in the queue

Parameters
constCKey & rhs
Returns
bool lessThan

References mCascadingLevel, CMathEventQueue::mCascadingLevel, mEquality, CMathEventQueue::mEquality, and mExecutionTime.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const CKey o 
)
friend

Member Data Documentation

◆ mCascadingLevel

size_t CMathEventQueue::CKey::mCascadingLevel
private

Cascading level

Referenced by operator<().

◆ mEquality

bool CMathEventQueue::CKey::mEquality
private

A Boolean value indication whether we have equality or inequality. Equalities have to be handled prior to inequalities

Referenced by operator<().

◆ mExecutionTime

C_FLOAT64 CMathEventQueue::CKey::mExecutionTime
private

The time the entry is scheduled to be executed.

Referenced by getExecutionTime(), and operator<().


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