MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Member Functions | List of all members
EVENTSLIB::EVENTSINTERNAL::EventGroupINT Class Reference

the class stores the concept of an event group internally in the Event library. More...

#include <eventgroup.h>

Public Member Functions

 EventGroupINT (const char *name)
 
 EventGroupINT (std::string &&name)
 
 EventGroupINT (idNum id, const std::string &name)
 
 EventGroupINT (idNum id, const std::string &name, const EVENTSLIB::RgbColor &color)
 
void setColor (const EVENTSLIB::RgbColor &color)
 
void setRandomColor ()
 
EVENTSLIB::RgbColor getColor () const
 
const std::string & getName () const
 
void setName (const std::string &sName)
 
idNum getId () const
 
std::string getDescription () const
 
int getOrder () const
 
void setOrder (int order)
 
bool operator< (const EventGroupINT &groupRHS) const
 

Detailed Description

the class stores the concept of an event group internally in the Event library.

EventGroupINT class.

Definition at line 154 of file eventgroup.h.

Constructor & Destructor Documentation

◆ EventGroupINT() [1/4]

EVENTSINTERNAL::EventGroupINT::EventGroupINT ( const char *  name)

EventGroupINT constructor.

Parameters
[in]namename of the group.

Definition at line 115 of file eventgroup.cpp.

◆ EventGroupINT() [2/4]

EVENTSINTERNAL::EventGroupINT::EventGroupINT ( std::string &&  name)

EventGroupINT constructorbased on an rvalue std::string.

Parameters
namename of the created group.

Definition at line 123 of file eventgroup.cpp.

◆ EventGroupINT() [3/4]

EVENTSINTERNAL::EventGroupINT::EventGroupINT ( idNum  id,
const std::string &  name 
)

EventGroupINT constructor based on a groupId and a name.

Parameters
[in]idId of the new group.
[in]nameName of the new group.

Definition at line 135 of file eventgroup.cpp.

◆ EventGroupINT() [4/4]

EVENTSINTERNAL::EventGroupINT::EventGroupINT ( idNum  id,
const std::string &  name,
const EVENTSLIB::RgbColor color 
)

EventGroupINT constructor.

Parameters
[in]idId of the new group.
[in]nameName of the new group.
[in]colorColor of the new group.

Definition at line 147 of file eventgroup.cpp.

Member Function Documentation

◆ getColor()

RgbColor EVENTSINTERNAL::EventGroupINT::getColor ( ) const

getColor Get the group color.

Returns
Color of the group.

Definition at line 167 of file eventgroup.cpp.

◆ getDescription()

std::string EVENTSINTERNAL::EventGroupINT::getDescription ( ) const

getDescription Get the group destriction.

Returns
description

Definition at line 204 of file eventgroup.cpp.

◆ getId()

idNum EVENTSINTERNAL::EventGroupINT::getId ( ) const

getId Retrieve the group id.

Returns
Id of the group

Definition at line 197 of file eventgroup.cpp.

◆ getName()

const std::string & EVENTSINTERNAL::EventGroupINT::getName ( ) const

getName Retrieve the name of the group.

Returns
Group name

Definition at line 183 of file eventgroup.cpp.

◆ getOrder()

int EVENTSINTERNAL::EventGroupINT::getOrder ( ) const

getOrder Get the order of the group.

Returns
order

Definition at line 211 of file eventgroup.cpp.

◆ operator<()

bool EVENTSINTERNAL::EventGroupINT::operator< ( const EventGroupINT groupRHS) const

operator < Overriden operator <.

Parameters
groupRHSobject to which compare.
Returns
results of comparison

Definition at line 225 of file eventgroup.cpp.

◆ setColor()

void EVENTSINTERNAL::EventGroupINT::setColor ( const EVENTSLIB::RgbColor color)

setColor Set the color of the group.

Parameters
[in]colorNew color of the group.

Definition at line 160 of file eventgroup.cpp.

◆ setName()

void EVENTSINTERNAL::EventGroupINT::setName ( const std::string &  sName)

setName Set the name of the group.

Parameters
sNameNew name of the group.

Definition at line 190 of file eventgroup.cpp.

◆ setOrder()

void EVENTSINTERNAL::EventGroupINT::setOrder ( int  order)

setOrder Set the group order.

Parameters
order

Definition at line 218 of file eventgroup.cpp.

◆ setRandomColor()

void EVENTSINTERNAL::EventGroupINT::setRandomColor ( )

setRandomColor Make the group adopt a random color.

Definition at line 174 of file eventgroup.cpp.


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