A class to represent an event. More...

#include <Event.h>

Public Member Functions
Event *	clone () const
	It returns a clone of this event. More...

std::string	getId () const
	It returns the object identification. More...

te::gm::Geometry *	getLocation () const
	It returns the location where the event happened. More...

void	getObjects (std::vector< te::st::Object * > &output) const
	It returns the objects involved to the event. More...

te::dt::DateTime *	getTime () const
	It returns the time when the event happened. More...

Event &	operator= (const Event &other)
	Copy assignment operator. More...

void	setId (const std::string &id)
	It sets the object identification. More...

void	setLocation (te::gm::Geometry *g)
	It sets the location where the event happened. More...

void	setObjects (std::vector< te::st::Object * > &objs)
	It sets the objects involved to the event. More...

void	setTime (te::dt::DateTime *t)
	It sets the time when the event happened. More...

virtual	~Event ()
	Virtual destructor. More...

Event Constructors
	Event (const std::string &id, te::dt::DateTime t, te::gm::Geometry g)
	Constructor. More...

	Event (const std::string &id, te::dt::DateTime t, te::gm::Geometry g, std::vector< te::st::Object * > objs)
	Constructor. More...

	Event (const Event &ts)
	Copy constructor. More...

Private Attributes
std::string	m_id
	The identification of the event. More...

std::auto_ptr< te::gm::Geometry >	m_location
	The location where the event happened. More...

std::vector< te::st::Object * >	m_objects
	The objects involved to the event. More...

std::auto_ptr< te::dt::DateTime >	m_time
	The time when the event happened. More...

Detailed Description

A class to represent an event.

An event is an individual episode with a definite beginning and end which can involve one or more objects.

See also: Object

Definition at line 59 of file Event.h.

Constructor & Destructor Documentation

te::st::Event::Event	(	const std::string &	id,
		te::dt::DateTime *	t,
		te::gm::Geometry *	g
	)

Constructor.

Parameters

id	The identification of the event.
t	The time when the event happened.
g	The location where the event happened.

Note: It will take the ownership of the input pointers.

te::st::Event::Event	(	const std::string &	id,
		te::dt::DateTime *	t,
		te::gm::Geometry *	g,
		std::vector< te::st::Object * >	objs
	)

Constructor.

Parameters

id	The identification of the event.
t	The time when the event happened.
g	The location where the event happened.
objs	The objects involved to the event.

Note: It will take the ownership of the input pointers.; It will NOT take the ownership of the involved objects.

te::st::Event::Event ( const Event & ts )

Copy constructor.

virtual te::st::Event::~Event ( )

virtual

Virtual destructor.

Member Function Documentation

Event* te::st::Event::clone ( ) const

It returns a clone of this event.

Returns: A new event.

Note: The caller will take the ownership of the returned pointer.

std::string te::st::Event::getId ( ) const

It returns the object identification.

Returns: The object identification.

te::gm::Geometry* te::st::Event::getLocation ( ) const

It returns the location where the event happened.

Returns: A pointer to the location where the event happened.

Note: The caller will NOT take the ownership of the returned pointer.

void te::st::Event::getObjects ( std::vector< te::st::Object * > & output ) const

It returns the objects involved to the event.

Returns: A pointer to the objects involved to the event.

Note: The caller will NOT take the ownership of the output pointers.

te::dt::DateTime* te::st::Event::getTime ( ) const

It returns the time when the event happened.

Returns: A pointer to the time when the event happened.

Note: The caller will NOT take the ownership of the returned pointer.

Event& te::st::Event::operator= ( const Event & other )

Copy assignment operator.

void te::st::Event::setId ( const std::string & id )

It sets the object identification.

Parameters

id	The object identification.

void te::st::Event::setLocation ( te::gm::Geometry * g )

It sets the location where the event happened.

Parameters

t	The location where the event happened.

Note: It will take the ownership of the input pointer.

void te::st::Event::setObjects ( std::vector< te::st::Object * > & objs )

It sets the objects involved to the event.

Parameters

objs	The objects involved to the event.

Note: It will NOT take the ownership of the input objects.

void te::st::Event::setTime ( te::dt::DateTime * t )

It sets the time when the event happened.

Parameters

t	The time when the event happened.

Note: It will take the ownership of the input pointer.

Member Data Documentation

std::string te::st::Event::m_id

private

The identification of the event.

Definition at line 184 of file Event.h.

std::auto_ptr<te::gm::Geometry> te::st::Event::m_location

private

The location where the event happened.

Definition at line 186 of file Event.h.

std::vector<te::st::Object*> te::st::Event::m_objects

private

The objects involved to the event.

Definition at line 187 of file Event.h.

std::auto_ptr<te::dt::DateTime> te::st::Event::m_time

private

The time when the event happened.

Definition at line 185 of file Event.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/st/core/event/Event.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation