v2.0.0
Loading...
Searching...
No Matches
EVENTSLIB Namespace Reference

Event annotation management (creation, grouping, shared-memory transport). More...

Namespaces

namespace  EVENTSINTERNAL

Classes

struct  Event
 Public event descriptor holding sample index, group membership, and unique identifier. More...
struct  RgbColor
 Simple RGB triplet for color-coding event groups. More...
struct  EventGroup
 EventGroup class is designed as a data holder for a group. It is designed towards ease of use for a client of the Events library. It's counterpart EventGroupINT is intended to be used internally by the Event library classes. More...
class  EventManager
 Central registry that creates, stores, queries, and groups Event objects across one or more data files. More...

Enumerations

enum  SharedMemoryMode { READ , WRITE , READWRITE }

Functions

template<typename T>
std::unique_ptr< std::vector< T > > allocateOutputContainer () noexcept
template<typename T>
std::unique_ptr< std::vector< T > > allocateOutputContainer (size_t size) noexcept
const char * buildDateTime ()
const char * buildHash ()
const char * buildHashLong ()

Detailed Description

Event annotation management (creation, grouping, shared-memory transport).

Enumeration Type Documentation

◆ SharedMemoryMode

Enumerator
READ 
WRITE 
READWRITE 

Definition at line 69 of file eventsharedmemmanager.h.

Function Documentation

◆ allocateOutputContainer() [1/2]

template<typename T>
std::unique_ptr< std::vector< T > > EVENTSLIB::allocateOutputContainer ( )
inlinenoexcept

Prepare memory allocation for the output of one of the methods in the class.

Definition at line 446 of file eventmanager.h.

◆ allocateOutputContainer() [2/2]

template<typename T>
std::unique_ptr< std::vector< T > > EVENTSLIB::allocateOutputContainer ( size_t size)
inlinenoexcept

Prepare memory allocation for the output of one of the methods in the class.

Definition at line 456 of file eventmanager.h.

◆ buildDateTime()

const char * EVENTSLIB::buildDateTime ( )

Returns build date and time.

Definition at line 46 of file events_global.cpp.

◆ buildHash()

const char * EVENTSLIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 50 of file events_global.cpp.

◆ buildHashLong()

const char * EVENTSLIB::buildHashLong ( )

Returns full build git hash.

Definition at line 54 of file events_global.cpp.