casacore
Public Member Functions | Private Attributes | List of all members
casacore::RORecordFieldPtr< T > Class Template Reference
casa package (libcasa_casa) » Containers_module

Read-Only access to an individual field from a Record. More...

#include <RecordField.h>

Public Member Functions

 RORecordFieldPtr ()
 
 RORecordFieldPtr (const RecordInterface &record, Int whichField)
 
 RORecordFieldPtr (const RecordInterface &record, const RecordFieldId &id)
 
 RORecordFieldPtr (const RecordFieldPtr< T > &other)
 
 RORecordFieldPtr (const RORecordFieldPtr< T > &other)
 
RORecordFieldPtr< T > & operator= (const RORecordFieldPtr< T > &other)
 
 ~RORecordFieldPtr ()
 
void attachToRecord (const RecordInterface &record, Int whichField)
 
void attachToRecord (const RecordInterface &record, const RecordFieldId &id)
 
const T & operator* () const
 
const T & get () const
 
const String & comment () const
 
Int fieldNumber () const
 
void detach ()
 
Bool isAttached () const
 

Private Attributes

RecordFieldPtr< T > fieldPtr_p
 

Detailed Description

template<class T>
class casacore::RORecordFieldPtr< T >

Read-Only access to an individual field from a Record.

Intended use:

Public interface

Review Status

Reviewed By:
Mark Wieringa
Date Reviewed:
1996/04/15
Test programs:
tRecord

Prerequisite

Synopsis

This class is entirely like RecordFieldPtr, except that it only allows Read-Only access to fields in a Record. The documentation for that class should be consulted.

Note that RecordFieldPtr is not inherited from RORecordFieldPtr, because that would give problems with the function attachToRecord. It would allow RecordFieldPtr to attach to a const RecordInterface object.

Definition at line 228 of file RecordField.h.

Constructor & Destructor Documentation

◆ RORecordFieldPtr() [1/5]

template<class T >
casacore::RORecordFieldPtr< T >::RORecordFieldPtr ( )
inline

Definition at line 231 of file RecordField.h.

◆ RORecordFieldPtr() [2/5]

template<class T >
casacore::RORecordFieldPtr< T >::RORecordFieldPtr ( const RecordInterface &  record,
Int  whichField 
)
inline

Definition at line 232 of file RecordField.h.

◆ RORecordFieldPtr() [3/5]

template<class T >
casacore::RORecordFieldPtr< T >::RORecordFieldPtr ( const RecordInterface &  record,
const RecordFieldId &  id 
)
inline

Definition at line 234 of file RecordField.h.

◆ RORecordFieldPtr() [4/5]

template<class T >
casacore::RORecordFieldPtr< T >::RORecordFieldPtr ( const RecordFieldPtr< T > &  other)
inline

Definition at line 236 of file RecordField.h.

◆ RORecordFieldPtr() [5/5]

template<class T >
casacore::RORecordFieldPtr< T >::RORecordFieldPtr ( const RORecordFieldPtr< T > &  other)
inline

Definition at line 238 of file RecordField.h.

◆ ~RORecordFieldPtr()

template<class T >
casacore::RORecordFieldPtr< T >::~RORecordFieldPtr ( )
inline

Definition at line 243 of file RecordField.h.

Member Function Documentation

◆ attachToRecord() [1/2]

template<class T >
void casacore::RORecordFieldPtr< T >::attachToRecord ( const RecordInterface &  record,
const RecordFieldId &  id 
)
inline

Definition at line 247 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ attachToRecord() [2/2]

template<class T >
void casacore::RORecordFieldPtr< T >::attachToRecord ( const RecordInterface &  record,
Int  whichField 
)
inline

Definition at line 245 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ comment()

template<class T >
const String& casacore::RORecordFieldPtr< T >::comment ( ) const
inline

Definition at line 253 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ detach()

template<class T >
void casacore::RORecordFieldPtr< T >::detach ( )
inline

Definition at line 258 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ fieldNumber()

template<class T >
Int casacore::RORecordFieldPtr< T >::fieldNumber ( ) const
inline

Definition at line 255 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ get()

template<class T >
const T& casacore::RORecordFieldPtr< T >::get ( ) const
inline

Definition at line 251 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ isAttached()

template<class T >
Bool casacore::RORecordFieldPtr< T >::isAttached ( ) const
inline

Definition at line 259 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ operator*()

template<class T >
const T& casacore::RORecordFieldPtr< T >::operator* ( ) const
inline

Definition at line 250 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

◆ operator=()

template<class T >
RORecordFieldPtr<T>& casacore::RORecordFieldPtr< T >::operator= ( const RORecordFieldPtr< T > &  other)
inline

Definition at line 240 of file RecordField.h.

References casacore::RORecordFieldPtr< T >::fieldPtr_p.

Member Data Documentation

◆ fieldPtr_p

template<class T >
RecordFieldPtr<T> casacore::RORecordFieldPtr< T >::fieldPtr_p
private

Definition at line 262 of file RecordField.h.

Referenced by casacore::RORecordFieldPtr< T >::attachToRecord(), casacore::RORecordFieldPtr< T >::comment(), casacore::RORecordFieldPtr< T >::detach(), casacore::RORecordFieldPtr< T >::fieldNumber(), casacore::RORecordFieldPtr< T >::get(), casacore::RORecordFieldPtr< T >::isAttached(), casacore::RORecordFieldPtr< T >::operator*(), and casacore::RORecordFieldPtr< T >::operator=().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1