casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
casacore::RecordNotice Class Reference

Helper class to notify class Record about changes. More...

#include <RecordInterface.h>

Inheritance diagram for casacore::RecordNotice:

Public Types

enum  NoticeType {
 Define the possible change types. More...

Public Member Functions

 RecordNotice (NoticeType changeType, uInt fieldNumber)
 Construct a notice for the given type and field number. More...
virtual uInt type () const
 Returns the change type. More...
virtual int operator== (const Notice &that) const
 Always returns False. More...
NoticeType changeType () const
 Return the change type. More...
Int fieldNumber () const
 Return the field number. More...
- Public Member Functions inherited from casacore::Notice
 Notice ()
virtual ~Notice ()

Private Attributes

NoticeType changeType_p
uInt fieldNumber_p

Detailed Description

Helper class to notify class Record about changes.

Intended use:


Review Status

Reviewed By:
Mark Wieringa
Date Reviewed:
Test programs:



This class is of essentially no interest. The Notification system which is used to invalidate RecordFieldPtr's to a destructed or changed record requires that a class derived from Notice be available to carry messages. There are 3 messages which are described below.

Definition at line 617 of file RecordInterface.h.

Member Enumeration Documentation

Define the possible change types.


Record has been deleted; detach all RecordFieldPtr's.


RecordRep has been copied; re-acquire the pointers in all RecordFieldPtr's.


A field has been removed; detach that RecordFieldPtr and decrement field numbers in RecordFieldPtr's following it.

Definition at line 621 of file RecordInterface.h.

Constructor & Destructor Documentation

casacore::RecordNotice::RecordNotice ( NoticeType  changeType,
uInt  fieldNumber 

Construct a notice for the given type and field number.

The field number is only used for type REMOVE.

Member Function Documentation

RecordNotice::NoticeType casacore::RecordNotice::changeType ( ) const

Return the change type.

Definition at line 653 of file RecordInterface.h.

References changeType_p.

Int casacore::RecordNotice::fieldNumber ( ) const

Return the field number.

Definition at line 657 of file RecordInterface.h.

References fieldNumber_p.

virtual int casacore::RecordNotice::operator== ( const Notice that) const

Always returns False.

Implements casacore::Notice.

virtual uInt casacore::RecordNotice::type ( ) const

Returns the change type.

Implements casacore::Notice.

Member Data Documentation

NoticeType casacore::RecordNotice::changeType_p

Definition at line 648 of file RecordInterface.h.

Referenced by changeType().

uInt casacore::RecordNotice::fieldNumber_p

Definition at line 649 of file RecordInterface.h.

Referenced by fieldNumber().

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