code::Index::NewRecordEvent Class Reference

Inheritance diagram for code::Index::NewRecordEvent:

List of all members.

---

Detailed Description

Posted whenever a new record is added to this Index.

To change how/when this object is posted, over-ride Index::notifyNewRecordEvent().

Author:

Lakshman

Version:

Id

code_Index.h,v 1.53 2011/09/23 16:37:32 Valliappa.Lakshmanan Exp

Public Member Functions
	NewRecordEvent (Index *idx, const Index::Record &item)
const Index::Record &	getRecord () const
virtual const std::string &	getDataType () const
	The string returned is the name of the data "Reflectivity" or the name of the event "NewVolume" depending on whether getRecord().isEvent() returns true or false.
virtual	~NewRecordEvent ()
ActionSource *	getSource () const
	Returns a pointer to the object that generated this ActionEvent.
const std::string &	getType () const
	Returns a source-specific type identifier to indicate what action occurred.

---

Constructor & Destructor Documentation

code::Index::NewRecordEvent::NewRecordEvent	(	Index *	idx,
		const Index::Record &	item
	)

virtual code::Index::NewRecordEvent::~NewRecordEvent

(

)

[virtual]

---

Member Function Documentation

virtual const std::string& code::Index::NewRecordEvent::getDataType

(

)

const [virtual]

The string returned is the name of the data "Reflectivity" or the name of the event "NewVolume" depending on whether getRecord().isEvent() returns true or false.

The assumption made here is that the second selection string is the data type. If this isn't true for the records that your Index creates, then you need to do two things:

1. Write a subclass of NewRecordEvent that implements this function correctly.
2. Override Index::notifyNewRecordEvent to fire events with an object of your class.

const Index::Record& code::Index::NewRecordEvent::getRecord

(

)

const [inline]

ActionSource* code::ActionEvent::getSource

(

)

const [inline, inherited]

Returns a pointer to the object that generated this ActionEvent.

Returns:

a pointer to the object that generated this ActionEvent.

const std::string& code::ActionEvent::getType

(

)

const [inline, inherited]

Returns a source-specific type identifier to indicate what action occurred.

Returns:

a source-specific type identifier to indicate what action occurred.

---