User API

Collaboration diagram for User API:

Modules
	Predefined colors

Classes
class	bactria::ranges::Category
	Defines a category. More...
class	bactria::ranges::Event
	The event class. More...
class	bactria::ranges::Marker
	The abstract base class for markers. More...
class	bactria::ranges::Range
	The range class. More...

Macros
#define	bactria_Event(name, color, category)
	A macro that fires an event. More...
#define	bactria_ActionEvent(action, color, category)
	A macro that fires an event with an action. More...

Detailed Description

User API for bactria's ranges functionality.

Macro Definition Documentation

bactria_ActionEvent

#define bactria_ActionEvent	(		action,
			color,
			category
	)

Value:

    {                                                                                                                 \
        auto e = bactria::ranges::Event("BACTRIA_ACTION_EVENT", color, category);                                     \
        e.set_action(action);                                                                                         \
        e.fire(__FILE__, __LINE__, __func__);                                                                         \
    }

A macro that fires an event with an action.

A macro that internally creates an event, assigns it an action, fires it and destroys it afterwards. If you want to customize the event's behaviour you will have to manage the event's lifetime and fire operation on your own by instantiating the Event class.

Parameters

[in]	action	The action generating the event name as it should later appear on the visualizer.
[in]	color	The color of the event as it should later appear on the visualizer.
[in]	category	The Category of the event.

bactria_Event

#define bactria_Event	(		name,
			color,
			category
	)

Value:

    {                                                                                                                 \
        auto e = bactria::ranges::Event(name, color, category);                                                       \
        e.fire(__FILE__, __LINE__, __func__);                                                                         \
    }

A macro that fires an event.

A macro that internally creates an event, fires it and destroys it afterwards. If you want to customize the event's behaviour you will have to manage the event's lifetime and fire operation on your own by instantiating the Event class.

Parameters

[in]	name	The name of the event as it should later appear on the visualizer.
[in]	color	The color of the event as it should later appear on the visualizer.
[in]	category	The Category of the event.