ECS_Annotater

- base class for classes that handle annotation requests

SYNOPSIS

#include <ECS/Annotater.hh>
class ECS_Annotater
{
  public:
	_ECSAIO_PRIVAPI ECS_Annotater();
	_ECSAIO_PRIVAPI ECS_Annotater(const ECS_AnnoFilter& filter);
	_ECSAIO_PRIVAPI virtual ~ECS_Annotater();
	_ECSAIO_PRIVAPI virtual ostream& print(ostream& os) const;
	_ECSAIO_PRIVAPI int32 connectToEngine(int32 instanceId);
	_ECSAIO_PRIVAPI int32 disconnectFromEngine(int32 instanceId);
	_ECSAIO_PRIVAPI ECS_AnnoFilter getFilter() const;
	_ECSAIO_PRIVAPI int32 setFilter
	(
	   const ECS_AnnoFilter& filter,
	   bool forceChange = false
	);
	_ECSAIO_PRIVAPI int32 clearFilter(bool forceChange = false);
	_ECSAIO_PRIVAPI virtual int32 receiveRequest
	( ECS_AnnoRequest request) = 0;
};

CLASS TYPE

Abstract Base

AUDIENCE

ECS Application Developers

DESCRIPTION

This class defines the interface which must be supported by any class which can be registered to receive and process annotation requests.

It is expected that most users will simply sub-class this class and override the definition of the method receiveRegquest() in the derived class to perform the appropriate annotation functionality.

Constructors and Destructors

_ECSAIO_PRIVAPI ECS_Annotater();: The default constructor
_ECSAIO_PRIVAPI ECS_Annotater(const ECS_AnnoFilter& filter);: A constructor which allows the initial filter to be set
_ECSAIO_PRIVAPI virtual ~ECS_Annotater();: The destructor

Utility

_ECSAIO_PRIVAPI virtual ostream& print(ostream& os) const;: Prints a textual representation of the class to the output stream specified via os.

Filtering

_ECSAIO_PRIVAPI int32 connectToEngine(int32 instanceId);: Register to receive annotation requests from the specified engine instance
_ECSAIO_PRIVAPI int32 disconnectFromEngine(int32 instanceId);: Stop receiving annotation requests from the specified engine instance

NOTES

None

LIBRARY

ECS

VERSION

1.5

DATE RELEASED

1998/02/25

AUTHOR(S)

Hewlett-Packard Company