casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::FunctionMarshallable Class Referenceabstract

More...

#include <FunctionMarshallable.h>

Public Member Functions

 FunctionMarshallable (const String &functype)
 create a FunctionMarshallable. More...
 
 FunctionMarshallable (const FunctionMarshallable &other)
 
virtual ~FunctionMarshallable ()
 
virtual void store (Record &gr) const =0
 store the state of this Function into a Record More...
 
virtual FunctionMarshallableoperator= (const FunctionMarshallable &other)
 
const StringgetFuncType () const
 return the name representing the Function type that will be placed in the functype field of Record passed to store(). More...
 
void loadFuncType (Record &gr) const
 load functype field into the given Record More...
 

Private Member Functions

 FunctionMarshallable ()
 

Private Attributes

String ftype
 

Detailed Description

a class for serializing/reconstituting Function objects to/from Records

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Marshalling (a.k.a. serialization) is the process of converting the state of an object into a transmitable form so that an another object with identical state can be created in another execution context. This class defines an interface for marshalling Functions.

Synopsis

Example

Motivation

Definition at line 85 of file FunctionMarshallable.h.

Constructor & Destructor Documentation

◆ FunctionMarshallable() [1/3]

casacore::FunctionMarshallable::FunctionMarshallable ( const String functype)
inline

create a FunctionMarshallable.

functype is the name that store() will load into the Record's functype field.

Definition at line 90 of file FunctionMarshallable.h.

◆ FunctionMarshallable() [2/3]

casacore::FunctionMarshallable::FunctionMarshallable ( const FunctionMarshallable other)
inline

Definition at line 91 of file FunctionMarshallable.h.

References ftype.

◆ ~FunctionMarshallable()

virtual casacore::FunctionMarshallable::~FunctionMarshallable ( )
inlinevirtual

Definition at line 94 of file FunctionMarshallable.h.

◆ FunctionMarshallable() [3/3]

casacore::FunctionMarshallable::FunctionMarshallable ( )
inlineprivate

Definition at line 119 of file FunctionMarshallable.h.

Member Function Documentation

◆ getFuncType()

const String& casacore::FunctionMarshallable::getFuncType ( ) const
inline

return the name representing the Function type that will be placed in the functype field of Record passed to store().

Definition at line 111 of file FunctionMarshallable.h.

References ftype.

◆ loadFuncType()

void casacore::FunctionMarshallable::loadFuncType ( Record gr) const
inline

load functype field into the given Record

Definition at line 114 of file FunctionMarshallable.h.

References casacore::String::c_str(), casacore::RecordInterface::define(), ftype, and casacore::SerialHelper::FUNCTYPE.

◆ operator=()

virtual FunctionMarshallable& casacore::FunctionMarshallable::operator= ( const FunctionMarshallable other)
inlinevirtual

◆ store()

virtual void casacore::FunctionMarshallable::store ( Record gr) const
pure virtual

store the state of this Function into a Record

Thrown Exceptions

Implemented in casacore::MarshButterworthBandpass< T >, and casacore::MarshallableChebyshev< T >.

Member Data Documentation

◆ ftype

String casacore::FunctionMarshallable::ftype
private

Definition at line 121 of file FunctionMarshallable.h.

Referenced by FunctionMarshallable(), getFuncType(), loadFuncType(), and operator=().


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