LookoutPointAtEvent Class Reference

#include <LookoutEvents.h>

Inheritance diagram for LookoutPointAtEvent:

Detailed Description

Definition at line 28 of file LookoutEvents.h.

Public Member Functions
virtual LookoutEventType_t	getLookoutEventType () const
	LookoutPointAtEvent ()
	LookoutPointAtEvent (bool _success, const fmat::Transform &mat)
	LookoutPointAtEvent (bool _success, const fmat::Transform &mat, EventGeneratorID_t gid, size_t sid, EventTypeID_t tid, unsigned int dur=0)
	LookoutPointAtEvent (bool _success, const fmat::Transform &mat, EventGeneratorID_t gid, size_t sid, EventTypeID_t tid, unsigned int dur, const std::string &n, float mag)
virtual EventBase *	clone () const
	allows a copy to be made of an event, supporting polymorphism
virtual unsigned int	getClassTypeID () const
	All subclasses should override this and return a unique ID for their class.
virtual std::string	getDescription (bool showTypeSpecific=true, unsigned int verbosity=0) const
	generates a description of the event with variable verbosity
virtual unsigned int	getBinSize () const
	should return the minimum size needed if using binary format (i.e. not XML)
virtual unsigned int	loadBinaryBuffer (const char buf[], unsigned int len)
	load from binary format
virtual unsigned int	saveBinaryBuffer (char buf[], unsigned int len) const
	save to binary format
virtual void	loadXML (xmlNode *node)
	load from XML format
virtual void	saveXML (xmlNode *node) const
	save to XML format
Public Attributes
fmat::Transform	toBaseMatrix
Static Protected Attributes
static const EventBase::classTypeID_t	autoRegisterLookoutPointAtEvent = getTypeRegistry().registerType<LookoutPointAtEvent>(makeClassTypeID("LOLA"))
	causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry())

Constructor & Destructor Documentation

LookoutPointAtEvent::LookoutPointAtEvent ( )

Definition at line 32 of file LookoutEvents.h.

Referenced by clone().

LookoutPointAtEvent::LookoutPointAtEvent	(	bool	_success,
		const fmat::Transform &	mat
	)

Definition at line 33 of file LookoutEvents.h.

LookoutPointAtEvent::LookoutPointAtEvent	(	bool	_success,
		const fmat::Transform &	mat,
		EventGeneratorID_t	gid,
		size_t	sid,
		EventTypeID_t	tid,
		unsigned int	dur = `0`
	)

Definition at line 34 of file LookoutEvents.h.

LookoutPointAtEvent::LookoutPointAtEvent	(	bool	_success,
		const fmat::Transform &	mat,
		EventGeneratorID_t	gid,
		size_t	sid,
		EventTypeID_t	tid,
		unsigned int	dur,
		const std::string &	n,
		float	mag
	)

Definition at line 37 of file LookoutEvents.h.

Member Function Documentation

virtual EventBase* LookoutPointAtEvent::clone ( ) const [virtual]

allows a copy to be made of an event, supporting polymorphism

Must be overridden by all subclasses to allow this to happen

I would like to switch this over to the cloneable interface once the compiler gets updated out of the 3.3 branch... see Cloneable::clone() for a discussion of the issue and implementation notes.

Reimplemented from EventBase.

Reimplemented in LookoutSketchEvent, and LookoutIREvent.

Definition at line 40 of file LookoutEvents.h.

unsigned int LookoutPointAtEvent::getBinSize ( ) const [virtual]

should return the minimum size needed if using binary format (i.e. not XML)

Reimplemented from EventBase.

Reimplemented in LookoutIREvent.

Definition at line 28 of file LookoutEvents.cc.

virtual unsigned int LookoutPointAtEvent::getClassTypeID ( ) const [virtual]

All subclasses should override this and return a unique ID for their class.

All IDs corresponding to all-capital letters are reserved for future framework expansion. (Thus, user subclasses should contain at least one lower-case letter.) This code can be used when serializing to allow quick identification of the class type by the receiver.

Reimplemented from EventBase.

Reimplemented in LookoutSketchEvent, and LookoutIREvent.

Definition at line 41 of file LookoutEvents.h.

std::string LookoutPointAtEvent::getDescription	(	bool	showTypeSpecific = `true`,
		unsigned int	verbosity = `0`
	)			const `[virtual]`

generates a description of the event with variable verbosity

Parameters:

showTypeSpecific

should be read by subclasses to add additional information

verbosity

can be one of the following values:

0 - Basic: event_name \t generator_id \t source_id \t type_id
1 - Numerics: event_name \t generator_id \t source_id \t type_id
2 - Timing: event_name \t generator_id \t source_id \t type_id \t duration \t timestamp
3 and above - Full: event_name \t generator_id \t source_id \t type_id \t duration \t timestamp \t magnitude if showTypeSpecific, additional fields will be added after the common fields listed above.