eventgroup.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef EVENTGROUP_EVENTS_H
#define EVENTGROUP_EVENTS_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include <string>
#include <cstdint>
#include "events_global.h"
 
//=============================================================================================================
// LOCAL DEFINITIONS
//=============================================================================================================
 
using idNum = unsigned int; //We want to eventually modify the idNum to be a hash string or a user-defined class. For now, just an int.
using uchar = unsigned char;
 
//=============================================================================================================
// NAMESPACE EVENTSLIB
//=============================================================================================================
 
namespace EVENTSLIB {
 
//=============================================================================================================
// EVENTSINTERNAL FORWARD DECLARATIONS
//=============================================================================================================
 
namespace EVENTSINTERNAL {
    class EventGroupINT;
}
 
//=============================================================================================================
struct EVENTS_EXPORT RgbColor
{
    //=========================================================================================================
    RgbColor();
 
    //=========================================================================================================
    RgbColor(const uchar rRhs, const uchar gRhs, const uchar bRhs);
 
    //=========================================================================================================
    RgbColor(const uchar rRhs, const uchar gRhs,
             const uchar bRhs, const uchar aRhs);
 
    uchar r;    
    uchar g;    
    uchar b;    
    uchar a;    
};

struct EVENTS_EXPORT EventGroup
{
 
    //=========================================================================================================
    EventGroup() = default;
 
    //=========================================================================================================
    EventGroup(const EVENTSLIB::EventGroup& g);
 
    //=========================================================================================================
    EventGroup(const EVENTSINTERNAL::EventGroupINT& g);
 
    idNum           id;     
    std::string     name;   
    RgbColor        color;  
    int             order;  
};
 
namespace EVENTSINTERNAL {

class EventGroupINT
{
public:
 
    //=========================================================================================================
    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;
 
private:
    std::string         m_sName;            
    EVENTSLIB::RgbColor m_Color;            
    idNum               m_Id;               
    std::string         m_sDescription;     
    int                 m_order;            
};
 
} //namespace EVENTSINTERNAL
} //namespace EVENTSLIB
#endif // EVENTGROUP_H