StreamFinder Class Reference
[History]

Used by the DistributeStates function below to find the HISTORY_STREAM corresponding to a given entity. More...

#include <history.hxx>

Inheritance diagram for StreamFinder:

[legend]

Collaboration diagram for StreamFinder:

[legend]

List of all members.

Public Member Functions
virtual HISTORY_STREAM *	findStream (ENTITY *ent, LookStrategy strategy=LookNormal)=0
	Returns the HISTORY_STREAM for any entity.
virtual HISTORY_STREAM *	quick_findStream (ENTITY *ent)
	Returns the HISTORY_STREAM for any entity whose stream needs to be quickly determined and thix is check is very fast.
	StreamFinder ()
	C++ allocation constructor requests memory for this object.

---

Detailed Description

Used by the DistributeStates function below to find the HISTORY_STREAM corresponding to a given entity.

Role: This class is used by the DistributeStates function below to find the HISTORY_STREAM corresponding to a given entity. It gives a great deal of flexibility and supports a variety of usage scenarios. At the same time user needs to be careful during usage. This is a class, instead of function pointers, hence it can cache data or arguments without using the global data hack. Examples of implementations are:

• Find the top level owner and get the stream from an ATTRIB_HISTORY found there.
• Find the PART for the ENTITY and return the stream associated with the PART.
• Always return the same stream.
• This is useful when the application has some knowledge about what has transpired and knows all BULLETINs go on the same stream.

See also:

HISTORY_MANAGER

---

Constructor & Destructor Documentation

StreamFinder::StreamFinder

(

)

C++ allocation constructor requests memory for this object.

---

Member Function Documentation

virtual HISTORY_STREAM* StreamFinder::findStream	(	ENTITY *	ent,
		LookStrategy	strategy = LookNormal
	)			[pure virtual]

Returns the HISTORY_STREAM for any entity.

Parameters:

	ent	Entity Object.
	strategy	Type of look strategy.

virtual HISTORY_STREAM* StreamFinder::quick_findStream

(

ENTITY *

ent

)

[inline, virtual]

Returns the HISTORY_STREAM for any entity whose stream needs to be quickly determined and thix is check is very fast.

Parameters:

ent

Entity Object.