samchon::library::ErrorEvent Class Reference

Event representing an error. More...

#include <ErrorEvent.hpp>

Collaboration diagram for samchon::library::ErrorEvent:

Public Member Functions
	ErrorEvent (EventDispatcher *, const std::string &)
	Construct from source and error-id. More...
auto	getMessage () const -> std::string
	Get error-id. More...
Public Member Functions inherited from samchon::library::Event
	Event (EventDispatcher *, int)
	Construct from source and type. More...
auto	getSource () const -> EventDispatcher *
	Get source of the Event. More...
auto	getType () const -> int
	Get type of the Event. More...

Protected Attributes
std::string	message
	Error message. More...
Protected Attributes inherited from samchon::library::Event
EventDispatcher *	source
	Source of the event. More...
int	type
	Type of the event. More...

Detailed Description

Event representing an error.

[Inherited]

The Event class is used as the base class for the creation of Event objects, which are passed as parameters to event listeners when an event occurs.

The properties of the Event class carry basic information about an event, such as the event's type or source (who made the event) of the event.

For many events, such as the events represented by the Event class constants, this basic information is sufficient. Other events, however, may require more detailed information.

Example Source

#include <iostream>
#include <thread>
#include <chrono>

#include <samchon/library/EventDispatcher.hpp>
#include <samchon/library/Event.hpp>
#include <samchon/library/ProgressEvent.hpp>

#ifdef _WIN64
#   ifdef _DEBUG
#       pragma comment(lib, "x64/Debug/SamchonFramework.lib")
#   else
#       pragma comment(lib, "x64/Release/SamchonFramework.lib")
#   endif
#else
#   ifdef _DEBUG
#       pragma comment(lib, "Debug/SamchonFramework.lib")
#   else
#       pragma comment(lib, "Release/SamchonFramework.lib")
#   endif
#endif

using namespace std;
using namespace samchon::library;

class Process
    : public EventDispatcher
{
public:
    Process()
    {

    };

    void run()
    {
        dispatchEvent(shared_ptr<Event>(new Event(this, Event::ACTIVATE)));

        for (size_t i = 0; i < 100; i++)
        {
            this_thread::sleep_for(chrono::seconds(1));
            dispatchEvent(shared_ptr<Event>(new ProgressEvent(this, i + 1, 100)));
        }

        dispatchEvent(shared_ptr<Event>(new Event(this, Event::COMPLETE)));
    };
};

void handleActivate(shared_ptr<Event> event)
{
    cout << "Activated" << endl;
}
void handleComplete(shared_ptr<Event> event)
{
    cout << "Completed" << endl;
}
void handleProgress(shared_ptr<Event> event)
{
    cout << dynamic_pointer_cast<ProgressEvent>(event)->getPercent() * 100.0 << "%" << endl;
}

void main()
{
    Process process;

    process.addEventListener(Event::ACTIVATE, handleActivate);
    process.addEventListener(Event::COMPLETE, handleComplete);
    process.addEventListener(ProgressEvent::PROGRESS, handleProgress);

    process.run();
    system("pause");
}

Deprecated:

Event is a candidate to be deprecated.

Since C++11, calling member method of a class by a new thread passing by static method and using void pointer are recommeded to avoid. As the reason, using std::thread and std::bind will be better.

• std::thread: http://www.cplusplus.com/reference/thread/thread/
• std::bind: http://www.cplusplus.com/reference/functional/bind/

See also

samchon::library

Author

Jeongho Nam http://samchon.org

Definition at line 19 of file ErrorEvent.hpp.

Constructor & Destructor Documentation

ErrorEvent::ErrorEvent	(	EventDispatcher *	,
		const std::string &
	)

Construct from source and error-id.

The event object owns its source and type

Parameters

source	Source of the event; who made the event
id	An error-id

Definition at line 7 of file ErrorEvent.cpp.

References message.

Member Function Documentation

auto ErrorEvent::getMessage

(

)

const -> std::string

Get error-id.

Definition at line 12 of file ErrorEvent.cpp.

References message.

Member Data Documentation

std::string samchon::library::ErrorEvent::message

protected

Error message.

Definition at line 36 of file ErrorEvent.hpp.

Referenced by ErrorEvent(), and getMessage().

---

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

• D:/OneDrive/Project/Samchon/framework/cpp/samchon/library/ErrorEvent.hpp
• D:/OneDrive/Project/Samchon/framework/cpp/samchon/library/ErrorEvent.cpp