ECS_AnnoFilter

- filter annotation requests

SYNOPSIS

#include <ECS/AnnoFilter.hh>

class ECS_AnnoFilter
{
  public:
	_ECSAIO_PRIVAPI ECS_AnnoFilter();
	_ECSAIO_PRIVAPI ECS_AnnoFilter
	(
	   const char* circuitName,
	   const char* annoNodeName = 0
	);
	_ECSAIO_PRIVAPI ECS_AnnoFilter(ECS_AnnoFilter const& other);
	ECS_AnnoFilter const& operator=(ECS_AnnoFilter const& other);
	_ECSAIO_PRIVAPI virtual ~ECS_AnnoFilter();
	virtual ostream& print(ostream& os) const;
	_ECSAIO_PRIVAPI const char* getCircuitName() const;
	_ECSAIO_PRIVAPI const char* getAnnotationNodeName() const;
	_ECSAIO_PRIVAPI void setCircuitName(const char* circuitName);
	_ECSAIO_PRIVAPI void clearCircuitName();
	_ECSAIO_PRIVAPI void setAnnotationNodeName( const char* annoNodeName );
	_ECSAIO_PRIVAPI void clearAnnotationNodeName();
	_ECSAIO_PRIVAPI void clear();
};

CLASS TYPE

Concrete

AUDIENCE

ECS Application Developers

DESCRIPTION

This class allows filtering of annotation requests to circuits and nodes.

Constructors and Destructors

_ECSAIO_PRIVAPI ECS_AnnoFilter();

The default constructor.

The default filter specifies all annotation requests.

_ECSAIO_PRIVAPI ECS_AnnoFilter(
const char* circuitName,
const char* annoNodeName = 0
);

A constructor which allows circuit name and optionally annotation node name to be specified.

The default filter specifies all annotation requests.

_ECSAIO_PRIVAPI ECS_AnnoFilter(ECS_AnnoFilter const& other);

The copy constructor.

ECS_AnnoFilter const& operator=(ECS_AnnoFilter const& other);

The assignment operator.

_ECSAIO_PRIVAPI virtual ~ECS_AnnoFilter();

The destructor.

Utility

virtual ostream& print(ostream& os) const;

Prints a textual representation of the class to the output stream specified via os.

Access

_ECSAIO_PRIVAPI const char* getCircuitName() const;

Returns the name of the circuit which will match this filter. If any circuit will match this filter then 0 will be returned.

_ECSAIO_PRIVAPI const char* getAnnotationNodeName() const;

Returns the name of the annotation node which will match this filter. If any circuit will match this filter then 0 will be returned.

Modification

_ECSAIO_PRIVAPI void setCircuitName(const char* circuitName);

Sets the name of the circuit from which annotation requests are to be received. If this filter is applied to an instance of ECS_Annotater the instance will only receive requests from circuits named circuitName.

Passing in a null pointer is equivalent to calling clearCircuitName().

_ECSAIO_PRIVAPI void clearCircuitName();

Resets the circuit name filter so that annotation requests from any circuit will match.

_ECSAIO_PRIVAPI void setAnnotationNodeName(const char* annoNodeName);

Sets the name of the circuit from which annotation requests are to be received. If this filter is applied to an instance of ECS_Annotater the instance will only receive requests from annotation nodes named annoNodeName.

Passing in a null pointer is equivalent to calling clearAnnotationNodeName().

_ECSAIO_PRIVAPI void clearAnnotationNodeName();

Resets the circuit name filter so that annotation requests from any annotation node will match.

_ECSAIO_PRIVAPI void clear();

Resets the filter so that annotation all requests will match.

NOTES

None.

SEE ALSO

ECS_Annotater

LIBRARY

ECS

VERSION

1.5

DATE RELEASED

1998/04/03

AUTHOR(S)

Hewlett-Packard Company

COPYRIGHT

Copyright (c) 1997 Hewlett-Packard Company. All Rights Reserved.