Empirical
Public Member Functions | List of all members
emp::SignalKey Class Reference

SignalKey tracks a specific function triggered by a signal. For now, its just a value pair. More...

#include <Signal.h>

Public Member Functions

 SignalKey (uint32_t _kid=0, uint32_t _sid=0)
 
 SignalKey (const SignalKey &)=default
 
SignalKeyoperator= (const SignalKey &)=default
 
 ~SignalKey ()
 
bool operator== (const SignalKey &in) const
 Are two signal keys identical? More...
 
bool operator!= (const SignalKey &in) const
 Are two signal keys different? More...
 
bool operator< (const SignalKey &in) const
 
bool operator> (const SignalKey &in) const
 
bool operator<= (const SignalKey &in) const
 
bool operator>= (const SignalKey &in) const
 
uint32_t GetID () const
 What is the KeyID associated with this signal key. More...
 
uint32_t GetSignalID () const
 What is the ID of the signal that this key is associated with. More...
 
bool IsActive () const
 Is this key currently pointing to a signal action? More...
 
void Set (uint32_t _kid=0, uint32_t _sid=0)
 Set this key to specified values. More...
 
void Clear ()
 Clear this key. More...
 
 operator bool ()
 

Detailed Description

SignalKey tracks a specific function triggered by a signal. For now, its just a value pair.

Constructor & Destructor Documentation

emp::SignalKey::SignalKey ( uint32_t  _kid = 0,
uint32_t  _sid = 0 
)
inline
emp::SignalKey::SignalKey ( const SignalKey )
default
emp::SignalKey::~SignalKey ( )
inline

Member Function Documentation

void emp::SignalKey::Clear ( )
inline

Clear this key.

uint32_t emp::SignalKey::GetID ( ) const
inline

What is the KeyID associated with this signal key.

uint32_t emp::SignalKey::GetSignalID ( ) const
inline

What is the ID of the signal that this key is associated with.

bool emp::SignalKey::IsActive ( ) const
inline

Is this key currently pointing to a signal action?

emp::SignalKey::operator bool ( )
inline
bool emp::SignalKey::operator!= ( const SignalKey in) const
inline

Are two signal keys different?

bool emp::SignalKey::operator< ( const SignalKey in) const
inline
bool emp::SignalKey::operator<= ( const SignalKey in) const
inline
SignalKey& emp::SignalKey::operator= ( const SignalKey )
default
bool emp::SignalKey::operator== ( const SignalKey in) const
inline

Are two signal keys identical?

bool emp::SignalKey::operator> ( const SignalKey in) const
inline
bool emp::SignalKey::operator>= ( const SignalKey in) const
inline
void emp::SignalKey::Set ( uint32_t  _kid = 0,
uint32_t  _sid = 0 
)
inline

Set this key to specified values.


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