SosSignalEvent Class Reference

Inheritance diagram for SosSignalEvent:

Collaboration diagram for SosSignalEvent:

Public Member Functions
	SosSignalEvent ()
	SosSignalEvent (Legion::EventHandle handle)
	~SosSignalEvent ()
Legion::UInt64	sourceId () const
void	setSourceId (const Legion::UInt64 &sourceId)
Legion::Vector3d	location () const
void	setLocation (const Legion::Vector3d &locationValue)
std::string	message () const
void	setMessage (const std::string &messageText)
Public Member Functions inherited from Legion::EventInstance
	EventInstance (const EventInstance &orig)
	copy constructor More...
EventInstance &	operator= (const EventInstance &orig)
	assignment operator More...
EventHandle	handle () const
	Returns the event handle to the internal representation. More...
EventId	typeId () const
	Returns the type ID of the event. More...
template<typename DATA_TYPE >
DATA_TYPE	data (ParameterId parameterId) const
	Returns the data of a given parameter. More...
template<typename DATA_TYPE >
const Span< DATA_TYPE >	dataArray (ParameterId parameterId) const
	Returns an array of data for a given parameters, if the particular parameter's cardinality is greater than one. More...
template<typename DATA_TYPE >
void	setData (ParameterId parameterId, const DATA_TYPE &val)
	Sets a given parameters value. More...
template<typename DATA_TYPE >
void	setDataArray (ParameterId parameterId, const Span< DATA_TYPE > &val)
	Sets a given parameter to an array of values, if the particular parameter's cardinality is greater than one. More...
void	setDataArrayLength (ParameterId paramId, UInt32 length)
	Set the length of a variable length array parameter. This only works for variable length array parameters. More...
UInt32	dataArrayLength (ParameterId paramId) const
	Get the length of the parameter if it is an array. More...

Static Public Member Functions
static Legion::EventId	typeId ()
static bool	registerEvent (Legion::EventManager &eventManager)

Static Public Attributes
static Legion::EventId	theEventType = 0
static Legion::ParameterId	theSourceIdParamId = Legion::BAD_INDEX
static Legion::ParameterId	theLocationParamId = Legion::BAD_INDEX
static Legion::ParameterId	theMessageParamId = Legion::BAD_INDEX
static const int	theMessageParameterLength = 256

Additional Inherited Members
Protected Member Functions inherited from Legion::EventInstance
	EventInstance (EventHandle handle)
	constructor More...
virtual	~EventInstance ()
Protected Attributes inherited from Legion::EventInstance
EventHandle	myHandle

Constructor & Destructor Documentation

SosSignalEvent::SosSignalEvent ( )

inline

SosSignalEvent::SosSignalEvent ( Legion::EventHandle  handle )

inline

SosSignalEvent::~SosSignalEvent ( )

inline

Member Function Documentation

Legion::Vector3d SosSignalEvent::location ( ) const

inline

References theLocationParamId.

Referenced by main(), and sosSignalCb().

std::string SosSignalEvent::message ( ) const

inline

References Legion::Span< DATA_TYPE >::data(), and theMessageParamId.

Referenced by main(), and sosSignalCb().

static bool SosSignalEvent::registerEvent ( Legion::EventManager &  eventManager )

inlinestatic

References Legion::BAD_INDEX, Legion::EventDescriptor::estimatedEventsPerFrame, Legion::EventDescriptor::eventName, Legion::EventDescriptor::parameterDescriptors, Legion::EventManager::parameterId(), Legion::EventManager::registerEvent(), theEventType, theLocationParamId, theMessageParameterLength, theMessageParamId, theSourceIdParamId, Legion::UInt64, Legion::UInt8, and Legion::Vector3d.

Referenced by main().

void SosSignalEvent::setLocation ( const Legion::Vector3d &  locationValue )

inline

References theLocationParamId.

Referenced by main().

void SosSignalEvent::setMessage ( const std::string &  messageText )

inline

References theMessageParameterLength, and theMessageParamId.

Referenced by main().

void SosSignalEvent::setSourceId ( const Legion::UInt64 &  sourceId )

inline

References sourceId(), and theSourceIdParamId.

Referenced by main().

Legion::UInt64 SosSignalEvent::sourceId ( ) const

inline

References theSourceIdParamId.

Referenced by main(), setSourceId(), and sosSignalCb().

static Legion::EventId SosSignalEvent::typeId ( )

inlinestatic

References theEventType.

Member Data Documentation

Legion::EventId SosSignalEvent::theEventType = 0

static

Referenced by registerEvent(), and typeId().

Legion::ParameterId SosSignalEvent::theLocationParamId = Legion::BAD_INDEX

static

Referenced by location(), registerEvent(), and setLocation().

const int SosSignalEvent::theMessageParameterLength = 256

static

Referenced by registerEvent(), and setMessage().

Legion::ParameterId SosSignalEvent::theMessageParamId = Legion::BAD_INDEX

static

Referenced by message(), registerEvent(), and setMessage().

Legion::ParameterId SosSignalEvent::theSourceIdParamId = Legion::BAD_INDEX

static

Referenced by registerEvent(), setSourceId(), and sourceId().

---

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

• customEvent.cxx