Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

InterpolationType< X > Class Template Reference

Interpolation base class for a specific data type. More...

#include <LUT.h>

Inheritance diagram for InterpolationType< X >:

Interpolation BaseType LUT< N, X > LUT< 1, X > List of all members.

Public Types

enum  Modes { LINEAR, SPLINE }

Public Methods

bool isInterpolated () const
 Return true if the interpolated table is ready for use.

virtual void serialize (Archive &)
 Serialize an object to or from a data archive.

virtual void parseXML (const char *cdata)
 Parse cdata from within the XML tags for this object.

virtual void convertXML ()
 Convert XML data to internal format prior to serialization.

virtual std::string asString () const=0
 Return a string representation of the instance.

virtual std::string typeString () const=0
 Return a string representation of the type.


Protected Methods

 InterpolationType ()
void find (X x, int &i, X &f) const
 Find the index and interpolation parameter for a given coordinate.

void postInterpolation (X x0, X x1, int n)
 Compute a few parameters needed for fast lookups.

void checkInterpolated () const
void checkNotInterpolated () const
void throwBreakpointOrder () const
void throwInterpolationMode () const

Protected Attributes

X m_X0
X m_X1
X m_XS
int m_Limit
bool m_Interpolated

Detailed Description

template<typename X>
class InterpolationType< X >

Interpolation base class for a specific data type.

Manages lookup indexing for the interpolated table.

Author:
Mark Rose <mrose@stm.lbl.gov>

Member Enumeration Documentation

enum Interpolation::Modes [inherited]
 

Enumeration values:
LINEAR 
SPLINE 

Constructor & Destructor Documentation

template<typename X>
InterpolationType< X >::InterpolationType (    )  [inline, protected]
 

Member Function Documentation

virtual std::string BaseType::asString (    )  [pure virtual, inherited]
 

Return a string representation of the instance.

This method is used to provide a string representation of the object for output to ostreams (using <<), and also serves as __repr__ in Python.

Implemented in SimDate, EnumLink, External, GeoPos, LLA, UTM, Curve, Table, Key, LinkBase, List< T >, LUT< N, X >, LUT< 1, X >, Matrix3, Object, Path, Quat, Real, Vector3, and LUT< N, T >.

void Interpolation::checkInterpolated (    )  const [inline, protected, inherited]
 

void Interpolation::checkNotInterpolated (    )  const [inline, protected, inherited]
 

void BaseType::convertXML (    )  [virtual, inherited]
 

Convert XML data to internal format prior to serialization.

This method is currently only called by the XML parser for Object classes. If another BaseType class requires this method, a call must be added to the appropriate XML handler in the parser.

template<typename X>
void InterpolationType< X >::find (  X    x,
int &    i,
X &    f
)  const [inline, protected]
 

Find the index and interpolation parameter for a given coordinate.

bool Interpolation::isInterpolated (    )  const [inline, inherited]
 

Return true if the interpolated table is ready for use.

void BaseType::parseXML (  const char *    cdata )  [virtual, inherited]
 

Parse cdata from within the XML tags for this object.

Reimplemented in SimDate, EnumLink, GeoPos, LLA, UTM, Matrix3, Quat, Real, and Vector3.

template<typename X>
void InterpolationType< X >::postInterpolation (  X    x0,
X    x1,
int    n
)  [protected]
 

Compute a few parameters needed for fast lookups.

Called after a LUT has been interpolated.

virtual void BaseType::serialize (  Archive &    )  [inline, virtual, inherited]
 

Serialize an object to or from a data archive.

Reimplemented in SimDate, EnumLink, External, GeoPos, LLA, UTM, InterpolatedData< T >, Curve, Table, Key, LinkBase, List< T >, LUT< N, X >, LUT< 1, X >, Matrix3, Object, Path, Quat, Real, Vector3, InterpolatedData< float >, and LUT< N, T >.

void Interpolation::throwBreakpointOrder (    )  const [inline, protected, inherited]
 

void Interpolation::throwInterpolationMode (    )  const [inline, protected, inherited]
 

virtual std::string BaseType::typeString (    )  [pure virtual, inherited]
 

Return a string representation of the type.

Implemented in SimDate, EnumLink, External, GeoPos, LLA, UTM, ECEF, Curve, Table, Key, LinkBase, Link< T >, LUT< N, X >, LUT< 1, X >, Matrix3, Object, Path, Quat, Real, Vector3, and LUT< N, T >.

Member Data Documentation

bool Interpolation::m_Interpolated [protected, inherited]
 

template<typename X>
int InterpolationType< X >::m_Limit [protected]
 

template<typename X>
X InterpolationType< X >::m_X0 [protected]
 

template<typename X>
X InterpolationType< X >::m_X1 [protected]
 

template<typename X>
X InterpolationType< X >::m_XS [protected]
 

The documentation for this class was generated from the following files:
SimData version pre-0.4.0. For more information on SimData, visit the SimData Homepage.

Generated on Tue Oct 14 12:06:41 2003, using Doxygen 1.2.18.

[SF.net]