casacore::NoticeTarget Class Reference

abstract base class for notice receptors More...

#include <Notice.h>

Public Member Functions
virtual	~NoticeTarget ()
	Destructs this NoticeTarget. More...
Bool	isValid () const
	Returns a boolean value telling whether this NoticeTarget is still "valid". More...
Bool	isAttached () const
	Returns a boolean value telling whether this NoticeTarget is still attached to a NoticeSource or not. More...
void	invalidate ()
	Makes the current NoticeTarget "invalid". More...
virtual void	notify (const Notice &)=0
	Hook through which NoticeTargets are notified (by NoticeSources). More...

Protected Member Functions
	NoticeTarget ()
	Creates an unlinked, "invalid" NoticeTarget. More...
	NoticeTarget (NoticeSource *v)
	Creates a "valid" NoticeTarget linked to the specified NoticeSource. More...
	NoticeTarget (NoticeSource &v)
	NoticeTarget (NoticeTarget &other)
	Creates a "valid" NoticeTarget linked to the same NoticeSource as the other NoticeTarget. More...
	NoticeTarget (NoticeTarget *other)
void	unlink ()
	Unlinks this NoticeTarget from its NoticeSource. More...
void	link (const NoticeTarget &other)
	Links this NoticeTarget to the same NoticeSource as the other NoticeTarget. More...
void	link (const NoticeTarget *other)
Link< NoticeTarget * > *	next ()
	Retrieves the next NoticeTarget in the target list of the associated NoticeSource. More...
const Link< NoticeTarget * > *	next () const
void	attach (NoticeSource *v)
	Adds this NoticeTarget to the target list in the specified NoticeSource, so that it will receive all notices sent out by that NoticeSource. More...
void	attach (NoticeSource &v)

Protected Attributes
Link< NoticeTarget * > *	ilink
NoticeSource *	container
Bool	valid

Friends
class	NoticeSource

Detailed Description

abstract base class for notice receptors

Intended use:

Public interface

Review Status

Reviewed By:

Friso Olnon

Date Reviewed:

1995/03/16

Synopsis

A NoticeTarget receives the Notices from the NoticeSource to which it is linked. A target can only be linked to one source.

Classes which are dependent upon a particular NoticeSource should derive from this class.

Example

ListIter and its parent class ConstListIter are the iterators or "dynamic" cursors in the linked List. They are derived from NoticeTarget, and the notice system ensures that multiple cursors are updated as elements are added and removed from the list, according to the following scheme:

1. An iterator changes something to the underlying list.
2. The iterator creates a ListNotice containing all the necessary information about the change.
3. The iterator passes the notice to the NoticeSource List.
4. The list relays the notice to all other iterators operating on the list (kept in the "target list").
5. Every iterator catches the notice and changes its state accordingly.

Definition at line 150 of file Notice.h.

Constructor & Destructor Documentation

~NoticeTarget()

virtual casacore::NoticeTarget::~NoticeTarget ( )

virtual

Destructs this NoticeTarget.

NoticeTarget() [1/5]

casacore::NoticeTarget::NoticeTarget ( )

inlineprotected

Creates an unlinked, "invalid" NoticeTarget.

An invalid NoticeTarget does not occur in the target list of any NoticeSource.

Definition at line 181 of file Notice.h.

NoticeTarget() [2/5]

casacore::NoticeTarget::NoticeTarget ( NoticeSource *  v )

inlineprotected

Creates a "valid" NoticeTarget linked to the specified NoticeSource.

The NoticeTarget will be added to the target list in that NoticeSource.

Definition at line 187 of file Notice.h.

References attach().

NoticeTarget() [3/5]

casacore::NoticeTarget::NoticeTarget ( NoticeSource &  v )

inlineprotected

Definition at line 188 of file Notice.h.

References attach().

NoticeTarget() [4/5]

casacore::NoticeTarget::NoticeTarget ( NoticeTarget &  other )

inlineprotected

Creates a "valid" NoticeTarget linked to the same NoticeSource as the other NoticeTarget.

So, both NoticeTargets will occur in the same target list.

Definition at line 196 of file Notice.h.

References attach(), container, and isValid().

NoticeTarget() [5/5]

casacore::NoticeTarget::NoticeTarget ( NoticeTarget *  other )

inlineprotected

Definition at line 198 of file Notice.h.

References attach(), and isValid().

Member Function Documentation

attach() [1/2]

void casacore::NoticeTarget::attach ( NoticeSource &  v )

protected

attach() [2/2]

void casacore::NoticeTarget::attach ( NoticeSource *  v )

protected

Adds this NoticeTarget to the target list in the specified NoticeSource, so that it will receive all notices sent out by that NoticeSource.

Referenced by NoticeTarget().

invalidate()

void casacore::NoticeTarget::invalidate ( )

inline

Makes the current NoticeTarget "invalid".

Definition at line 166 of file Notice.h.

References casacore::False, and valid.

isAttached()

Bool casacore::NoticeTarget::isAttached ( ) const

inline

Returns a boolean value telling whether this NoticeTarget is still attached to a NoticeSource or not.

Definition at line 163 of file Notice.h.

References casacore::False, ilink, and casacore::True.

Referenced by casacore::RecordFieldPtr< T >::isAttached().

isValid()

Bool casacore::NoticeTarget::isValid ( ) const

inline

Returns a boolean value telling whether this NoticeTarget is still "valid".

Definition at line 159 of file Notice.h.

References valid.

Referenced by casacore::ListIter< t >::addRight(), casacore::ConstListIter< t >::atEnd(), casacore::ConstListIter< t >::atStart(), casacore::ListIter< t >::getRight(), casacore::ConstListIter< t >::getRight(), casacore::ConstListIter< t >::len(), NoticeTarget(), casacore::ConstListIter< t >::operator++(), casacore::ConstListIter< t >::pos(), casacore::ConstListIter< t >::step(), casacore::ConstListIter< t >::toEnd(), and casacore::ConstListIter< t >::toStart().

link() [1/2]

void casacore::NoticeTarget::link ( const NoticeTarget &  other )

protected

Links this NoticeTarget to the same NoticeSource as the other NoticeTarget.

Any previous link will be undone.

link() [2/2]

void casacore::NoticeTarget::link ( const NoticeTarget *  other )

protected

next() [1/2]

Link<NoticeTarget*>* casacore::NoticeTarget::next ( )

inlineprotected

Retrieves the next NoticeTarget in the target list of the associated NoticeSource.

Definition at line 217 of file Notice.h.

References ilink.

next() [2/2]

const Link<NoticeTarget*>* casacore::NoticeTarget::next ( ) const

inlineprotected

Definition at line 220 of file Notice.h.

References ilink.

notify()

virtual void casacore::NoticeTarget::notify ( const Notice &  )

pure virtual

Hook through which NoticeTargets are notified (by NoticeSources).

Implemented in casacore::RecordFieldPtr< T >, casacore::RecordFieldPtr< Double >, casacore::RecordFieldPtr< Int >, casacore::RecordFieldPtr< Bool >, casacore::RecordFieldPtr< outType >, casacore::RecordFieldPtr< casacore::Array< T > >, casacore::RecordFieldPtr< casacore::String >, casacore::OrderedMapIterRep< key, value >, and casacore::ConstListIter< t >.

unlink()

void casacore::NoticeTarget::unlink ( )

protected

Unlinks this NoticeTarget from its NoticeSource.

The NoticeTarget will be removed from the target list.

Friends And Related Function Documentation

NoticeSource

friend class NoticeSource

friend

Definition at line 152 of file Notice.h.

Member Data Documentation

container

NoticeSource* casacore::NoticeTarget::container

protected

Definition at line 175 of file Notice.h.

Referenced by NoticeTarget().

ilink

Link<NoticeTarget*>* casacore::NoticeTarget::ilink

protected

Definition at line 174 of file Notice.h.

Referenced by isAttached(), and next().

valid

Bool casacore::NoticeTarget::valid

protected

Definition at line 176 of file Notice.h.

Referenced by invalidate(), and isValid().

---

The documentation for this class was generated from the following file:

• casa/Utilities/Notice.h