Base Class Reference

Base class. More...

#include <Object.h>

Inheritance diagram for Base:

Public Member Functions
	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.
virtual QString	toQString (const QString &sPrefix="", bool bShort=true) const
	Formatted string version for debugging purposes.

Static Public Member Functions
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

Static Public Attributes
static QString	sPrintIndention = " "
	String used to format the debugging string output of some core classes.

Protected Member Functions
	~Base ()

Static Protected Member Functions
static void	registerClass (const char *name, const atomic_obj_cpt_t *counters)

Static Protected Attributes
static bool	__count = false
	should we count class instances
static timeval	__last_clock = { 0, 0 }
static Logger *	__logger = nullptr
static bool	bLogColors = true

Static Private Attributes
static pthread_mutex_t	__mutex
	yeah this has to be thread safe
static std::atomic< int >	__objects_count
	total objects count
static object_internal_map_t	__objects_map
	objects classes and instances count structure

Detailed Description

Base class.

Definition at line 62 of file Object.h.

Constructor & Destructor Documentation

Base() [1/2]

Base ( )

inline

Definition at line 64 of file Object.h.

Base() [2/2]

Base ( const Base & other )

inline

Definition at line 71 of file Object.h.

~Base()

~Base ( )

inlineprotected

Definition at line 148 of file Object.h.

Member Function Documentation

_class_name()

static const char * _class_name ( )

inlinestatic

return the class name

Definition at line 78 of file Object.h.

base_clock()

QString base_clock ( const QString & sMsg )

static

Measures the current time and stores it in __last_clock.

In case __last_clock was already set - base_clock() was invoked at least once - the time difference will be logged with DEBUG level.

Definition at line 223 of file Object.cpp.

base_clock_in()

QString base_clock_in ( const QString & sMsg )

static

Definition at line 209 of file Object.cpp.

bootstrap()

int bootstrap ( Logger * logger, bool count = false )

static

must be called before any Object instantiation !

Parameters

logger	the logger instance used to send messages to
count	should we count objects instances or not

Definition at line 66 of file Object.cpp.

class_name()

virtual const char * class_name ( ) const

inlinevirtual

Definition at line 79 of file Object.h.

count_active()

static bool count_active ( )

inlinestatic

Definition at line 85 of file Object.h.

getAliveObjectCount()

int getAliveObjectCount ( )

static

Returns

Total numbers of objects being alive.

Definition at line 139 of file Object.cpp.

getObjectMap()

object_map_t getObjectMap ( )

static

Returns

Copy of the object map.

Definition at line 154 of file Object.cpp.

logBacktrace()

void logBacktrace

(

)

const

Print the current stack at point into the debug log.

Definition at line 195 of file Object.cpp.

logger()

static Logger * logger ( )

inlinestatic

return the logger instance

Definition at line 103 of file Object.h.

objects_count()

static int objects_count ( )

inlinestatic

Definition at line 86 of file Object.h.

Print()

void Print

(

bool

bShort = true

)

const

Prints content of toQString() via DEBUGLOG.

Parameters

bShort

Whether to display the content of the member class variables and to use line breaks.

Definition at line 191 of file Object.cpp.

printObjectMapDiff()

void printObjectMapDiff ( object_map_t map )

static

Creates the difference between a snapshot of the object map and its current state and prints it to std::cout.

Parameters

map	Object map retrieved using getObjectMap().

Definition at line 167 of file Object.cpp.

registerClass()

void registerClass ( const char * name, const atomic_obj_cpt_t * counters )

staticprotected

Definition at line 255 of file Object.cpp.

set_count()

void set_count ( bool flag )

static

enable/disable class instances counting

Parameters

flag	the counting status to set

Definition at line 79 of file Object.cpp.

toQString()

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

virtual

Formatted string version for debugging purposes.

Parameters

sPrefix	String prefix which will be added in front of every new line
bShort	Instead 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 in Action, ADSR, AudioEngine, AutomationPath, Drumkit, DrumkitComponent, Hydrogen, Instrument, InstrumentComponent, InstrumentLayer, InstrumentList, License, Note, Pattern, PatternList, Playlist, Sample, Song, SoundLibraryDatabase, SoundLibraryInfo, Timeline, TransportPosition, and MidiMap.

Definition at line 186 of file Object.cpp.

write_objects_map_to()

void write_objects_map_to ( std::ostream & out, object_map_t * map = nullptr )

static

output the full objects map to a given ostream

Parameters

out	the ostream to write to
map	Object map to print out. Per default the current object map __objects_map will be used.

Definition at line 89 of file Object.cpp.

write_objects_map_to_cerr()

static void write_objects_map_to_cerr ( )

inlinestatic

output objects map to stderr

Definition at line 95 of file Object.h.

Field Documentation

__count

bool __count = false

staticprotected

should we count class instances

Definition at line 155 of file Object.h.

__last_clock

timeval __last_clock = { 0, 0 }

staticprotected

Definition at line 159 of file Object.h.

__logger

Logger * __logger = nullptr

staticprotected

Definition at line 156 of file Object.h.

__mutex

pthread_mutex_t __mutex

staticprivate

yeah this has to be thread safe

Definition at line 164 of file Object.h.

__objects_count

std::atomic< int > __objects_count

staticprivate

total objects count

Definition at line 162 of file Object.h.

__objects_map

object_internal_map_t __objects_map

staticprivate

objects classes and instances count structure

Definition at line 163 of file Object.h.

bLogColors

bool bLogColors = true

staticprotected

Definition at line 157 of file Object.h.

sPrintIndention

QString sPrintIndention = " "

static

String used to format the debugging string output of some core classes.

Definition at line 127 of file Object.h.