EVENTSLIB::EVENTSINTERNAL::EventINT Class Reference

#include <event.h>

Public Member Functions
	EventINT (idNum id)
	EventINT (idNum id, int iSample, idNum groupId)
	EventINT (const EventINT &rhs)
	EventINT (EventINT &&other)
int	getSample () const
void	setSample (int iSample)
idNum	getGroupId () const
void	setGroupId (idNum iGroup)
idNum	getId () const
std::string	getDescription () const
void	setDescription (const std::string &description)
void	setDescription (std::string &&description)
bool	operator< (const EventINT &rhs) const
bool	operator== (const EventINT &rhs) const
EventINT	operator= (const EventINT &rhs)

Static Public Member Functions
static EventINT	fromSample (int iSample)

Detailed Description

The EventINT class

The events are objects of this class internally in the library.

Definition at line 115 of file event.h.

Constructor & Destructor Documentation

EventINT() [1/4]

EVENTSINTERNAL::EventINT::EventINT

(

idNum

id

)

EventINT constructor.

Parameters

[in]

Id

of the new event.

Definition at line 85 of file event.cpp.

EventINT() [2/4]

EVENTSINTERNAL::EventINT::EventINT	(	idNum	id,
		int	iSample,
		idNum	groupId
	)

EventINT constructor.

Parameters

[in]	id	Id of the new event.
[in]	iSample	Sample of the new created event.
[in]	groupId	GroupId to which the created event will belong.

Definition at line 91 of file event.cpp.

EventINT() [3/4]

EVENTSINTERNAL::EventINT::EventINT

(

const EventINT &

rhs

)

Copy constructor for the EventINT class.

Parameters

rhs	Rhs EventINT object.

Definition at line 100 of file event.cpp.

EventINT() [4/4]

EVENTSINTERNAL::EventINT::EventINT

(

EventINT &&

other

)

Move constructor

Parameters

other

Object to be moved.

Definition at line 109 of file event.cpp.

Member Function Documentation

fromSample()

EventINT EVENTSLIB::EVENTSINTERNAL::EventINT::fromSample ( int  sample )

inlinestatic

Create an event at sample iSample

Parameters

[in]	iSample	Create an EventINT event from a specific sample.
[in]	sample	Sample of the new event.

Returns

new event created.

Definition at line 269 of file event.h.

getDescription()

std::string EVENTSINTERNAL::EventINT::getDescription

(

)

const

Retrieve this event's description.

Returns

Event Description.

Definition at line 153 of file event.cpp.

getGroupId()

idNum EVENTSINTERNAL::EventINT::getGroupId

(

)

const

Returns event group

Returns

Event group.

Definition at line 132 of file event.cpp.

getId()

idNum EVENTSINTERNAL::EventINT::getId

(

)

const

Retrieve this event's id.

Returns

Id Event Id.

Definition at line 146 of file event.cpp.

getSample()

int EVENTSINTERNAL::EventINT::getSample

(

)

const

Returns event sample.

Returns

Event sample.

Definition at line 118 of file event.cpp.

operator<()

bool EVENTSINTERNAL::EventINT::operator<

(

const EventINT &

rhs

)

const

Overriden < operator. This operator helps the organization of events in standard library containers.

Parameters

[in]

rhs

EventINT to compare to.

Returns

Bool value with the result of the comparison.

Definition at line 160 of file event.cpp.

operator=()

EVENTSINTERNAL::EventINT EVENTSINTERNAL::EventINT::operator=

(

const EventINT &

rhs

)

Overriden = operator in case of need to copy assing an event.

Parameters

rhs	EventINT to copy assign to.

Returns

a new EventINT created.

Definition at line 172 of file event.cpp.

operator==()

bool EVENTSINTERNAL::EventINT::operator==

(

const EventINT &

rhs

)

const

Overriden == operator. This operator helps the organization of events in standard library containers.

Parameters

[in]

rhs

EventINT to compare to.

Returns

Bool value with the result of the comparison.

Definition at line 167 of file event.cpp.

setDescription() [1/2]

void EVENTSLIB::EVENTSINTERNAL::EventINT::setDescription

(

const std::string &

description

)

Set this event's description.

Parameters

[in]

description

The new description text.

setDescription() [2/2]

void EVENTSLIB::EVENTSINTERNAL::EventINT::setDescription

(

std::string &&

description

)

Set this event's description from a rvalue string.

Parameters

[in]

description

The new description.

setGroupId()

void EVENTSINTERNAL::EventINT::setGroupId

(

idNum

iGroup

)

Set the value of the group of this event.

Parameters

iGroup

Group id.

Definition at line 139 of file event.cpp.

setSample()

void EVENTSINTERNAL::EventINT::setSample

(

int

iSample

)

setSample Set the value of the event sample.

Parameters

iSample

sample.

Definition at line 125 of file event.cpp.

---

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

• src/libraries/events/event.h
• src/libraries/events/event.cpp