gd::EventsSearchResult Class Reference

Class used to return result when calling EventsRefactorer::SearchInEvents. More...

#include <EventsRefactorer.h>

Public Member Functions
	EventsSearchResult (std::weak_ptr< gd::BaseEvent > event_, gd::EventsList *eventsList_, std::size_t positionInList_)
bool	IsEventsListValid () const
const gd::EventsList &	GetEventsList () const
	Get the events list containing the event pointed by the EventsSearchResult. More...
std::size_t	GetPositionInList () const
bool	IsEventValid () const
const gd::BaseEvent &	GetEvent () const
	Get the event pointed by the EventsSearchResult. More...

Public Attributes
std::weak_ptr< gd::BaseEvent >	event
gd::EventsList *	eventsList
std::size_t	positionInList

Detailed Description

Class used to return result when calling EventsRefactorer::SearchInEvents.

See also

EventsRefactorer::SearchInEvents

Member Function Documentation

GetEvent()

const gd::BaseEvent& gd::EventsSearchResult::GetEvent ( ) const

inline

Get the event pointed by the EventsSearchResult.

Warning

Only call this when IsEventValid returns true.

GetEventsList()

const gd::EventsList& gd::EventsSearchResult::GetEventsList ( ) const

inline

Get the events list containing the event pointed by the EventsSearchResult.

Warning

Only call this when IsEventsListValid returns true.

---

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

• EventsRefactorer.h
• EventsRefactorer.cpp