casa::FunctionMarshallable Class Reference

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

#include <FunctionMarshallable.h>

Inheritance diagram for casa::FunctionMarshallable:

List of all members.

Public Member Functions
	FunctionMarshallable (const String &functype)
	create a FunctionMarshallable.
	FunctionMarshallable (const FunctionMarshallable &other)
virtual	~FunctionMarshallable ()
virtual void	store (Record &gr) const =0
	store the state of this Function into a Record
virtual FunctionMarshallable &	operator= (const FunctionMarshallable &other)
const String &	getFuncType () const
	return the name representing the Function type that will be placed in the functype field of Record passed to store().
void	loadFuncType (Record &gr) const
	load functype field into the given Record
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

• FunctionFactory
• Function

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 84 of file FunctionMarshallable.h.

---

Constructor & Destructor Documentation

casa::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 89 of file FunctionMarshallable.h.

casa::FunctionMarshallable::FunctionMarshallable

(

const FunctionMarshallable &

other

)

[inline]

Definition at line 90 of file FunctionMarshallable.h.

References ftype.

virtual casa::FunctionMarshallable::~FunctionMarshallable

(

)

[inline, virtual]

Definition at line 93 of file FunctionMarshallable.h.

casa::FunctionMarshallable::FunctionMarshallable

(

)

[inline, private]

Definition at line 118 of file FunctionMarshallable.h.

---

Member Function Documentation

const String& casa::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 110 of file FunctionMarshallable.h.

References ftype.

void casa::FunctionMarshallable::loadFuncType

(

Record &

gr

)

const [inline]

load functype field into the given Record

Definition at line 113 of file FunctionMarshallable.h.

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

virtual FunctionMarshallable& casa::FunctionMarshallable::operator=

(

const FunctionMarshallable &

other

)

[inline, virtual]

Definition at line 102 of file FunctionMarshallable.h.

References ftype.

virtual void casa::FunctionMarshallable::store

(

Record &

gr

)

const [pure virtual]

store the state of this Function into a Record

Thrown Exceptions

• InvalidSerializationError if an error during serialization

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

---

Member Data Documentation

String casa::FunctionMarshallable::ftype [private]

Definition at line 120 of file FunctionMarshallable.h.

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

---

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

• casacore/scimath/Functionals/FunctionMarshallable.h