hydrogen 1.2.5
Action Class Reference
Core of hydrogen | MIDI

#include <MidiAction.h>

Inheritance diagram for Action:
Object< Action > Base

Public Member Functions

 Action (QString sType=getNullActionType())
 Action (std::shared_ptr< Action > pOther)
QString getParameter1 () const
QString getParameter2 () const
QString getParameter3 () const
QString getType () const
QString getValue () const
bool isEquivalentTo (std::shared_ptr< Action > pOther)
bool isNull () const
 Checks whether m_sType is of getNullActionType()
void setParameter1 (QString text)
void setParameter2 (QString text)
void setParameter3 (QString text)
void setValue (QString text)
QString toQString (const QString &sPrefix="", bool bShort=true) const override
 Formatted string version for debugging purposes.
Public Member Functions inherited from Object< Action >
 Object ()
Public Member Functions inherited from Base
 Base ()
 Base (const Base &other)
virtual const char * class_name () const
void logBacktrace () const
 Print the current stack at point into the debug log.
void Print (bool bShort=true) const
 Prints content of toQString() via DEBUGLOG.

Static Public Member Functions

static QString getNullActionType ()
Static Public Member Functions inherited from Base
static const char * _class_name ()
 return the class name
static QString base_clock (const QString &sMsg)
 Measures the current time and stores it in __last_clock.
static QString base_clock_in (const QString &sMsg)
static int bootstrap (Logger *logger, bool count=false)
 must be called before any Object instantiation !
static bool count_active ()
static int getAliveObjectCount ()
static object_map_t getObjectMap ()
static Logger * logger ()
 return the logger instance
static int objects_count ()
static void printObjectMapDiff (object_map_t map)
 Creates the difference between a snapshot of the object map and its current state and prints it to std::cout.
static void set_count (bool flag)
 enable/disable class instances counting
static void write_objects_map_to (std::ostream &out, object_map_t *map=nullptr)
 output the full objects map to a given ostream
static void write_objects_map_to_cerr ()
 output objects map to stderr

Private Attributes

QString m_sParameter1
QString m_sParameter2
QString m_sParameter3
QString m_sType
QString m_sValue

Friends

bool operator!= (const Action &lhs, const Action &rhs)
bool operator!= (std::shared_ptr< Action > lhs, std::shared_ptr< Action > rhs)
bool operator== (const Action &lhs, const Action &rhs)
bool operator== (std::shared_ptr< Action > lhs, std::shared_ptr< Action > rhs)

Additional Inherited Members

Static Public Attributes inherited from Base
static QString sPrintIndention = " "
 String used to format the debugging string output of some core classes.
Protected Member Functions inherited from Object< Action >
 ~Object ()
Protected Member Functions inherited from Base
 ~Base ()
Static Protected Member Functions inherited from Base
static void registerClass (const char *name, const atomic_obj_cpt_t *counters)
Static Protected Attributes inherited from Base
static bool __count = false
 should we count class instances
static timeval __last_clock = { 0, 0 }
static Logger * __logger = nullptr
static bool bLogColors = true

Detailed Description

Definition at line 31 of file MidiAction.h.

Constructor & Destructor Documentation

◆ Action() [1/2]

Action ( QString sType = getNullActionType())

Definition at line 72 of file MidiAction.cpp.

◆ Action() [2/2]

Action ( std::shared_ptr< Action > pOther)

Definition at line 80 of file MidiAction.cpp.

Member Function Documentation

◆ getNullActionType()

QString getNullActionType ( )
inlinestatic

Definition at line 34 of file MidiAction.h.

◆ getParameter1()

QString getParameter1 ( ) const
inline

Definition at line 60 of file MidiAction.h.

◆ getParameter2()

QString getParameter2 ( ) const
inline

Definition at line 64 of file MidiAction.h.

◆ getParameter3()

QString getParameter3 ( ) const
inline

Definition at line 68 of file MidiAction.h.

◆ getType()

QString getType ( ) const
inline

Definition at line 76 of file MidiAction.h.

◆ getValue()

QString getValue ( ) const
inline

Definition at line 72 of file MidiAction.h.

◆ isEquivalentTo()

bool isEquivalentTo ( std::shared_ptr< Action > pOther)
Returns
whether the current action and pOther identically in all member except of m_sValue. If true, they are associated with the same widget. The value will differ depending on the incoming MIDI event.

Definition at line 92 of file MidiAction.cpp.

◆ isNull()

bool isNull ( ) const

Checks whether m_sType is of getNullActionType()

Definition at line 88 of file MidiAction.cpp.

◆ setParameter1()

void setParameter1 ( QString text)
inline

Definition at line 44 of file MidiAction.h.

◆ setParameter2()

void setParameter2 ( QString text)
inline

Definition at line 48 of file MidiAction.h.

◆ setParameter3()

void setParameter3 ( QString text)
inline

Definition at line 52 of file MidiAction.h.

◆ setValue()

void setValue ( QString text)
inline

Definition at line 56 of file MidiAction.h.

◆ toQString()

QString toQString ( const QString & sPrefix = "",
bool bShort = true ) const
overridevirtual

Formatted string version for debugging purposes.

Parameters
sPrefixString prefix which will be added in front of every new line
bShortInstead of the whole content of all classes stored as members just a single unique identifier will be displayed without line breaks.
Returns
String presentation of current object.

Reimplemented from Base.

Definition at line 103 of file MidiAction.cpp.

◆ operator!= [1/2]

bool operator!= ( const Action & lhs,
const Action & rhs )
friend

Definition at line 95 of file MidiAction.h.

◆ operator!= [2/2]

bool operator!= ( std::shared_ptr< Action > lhs,
std::shared_ptr< Action > rhs )
friend

Definition at line 109 of file MidiAction.h.

◆ operator== [1/2]

bool operator== ( const Action & lhs,
const Action & rhs )
friend

Definition at line 88 of file MidiAction.h.

◆ operator== [2/2]

bool operator== ( std::shared_ptr< Action > lhs,
std::shared_ptr< Action > rhs )
friend

Definition at line 102 of file MidiAction.h.

Field Documentation

◆ m_sParameter1

QString m_sParameter1
private

Definition at line 129 of file MidiAction.h.

◆ m_sParameter2

QString m_sParameter2
private

Definition at line 130 of file MidiAction.h.

◆ m_sParameter3

QString m_sParameter3
private

Definition at line 131 of file MidiAction.h.

◆ m_sType

QString m_sType
private

Definition at line 128 of file MidiAction.h.

◆ m_sValue

QString m_sValue
private

Definition at line 132 of file MidiAction.h.