Auxiliary base class for interpolation of magnetic declination data obtained from website of NOAA. More...

#include <JNOAA.hh>

Inheritance diagram for JCOMPASS::JNOAAFunction1D_t:

Public Types
typedef JGridCollection< JElement2D< double, double >, JDistance< typename JElement2D< double, double >::abscissa_type > >	collection_type

typedef collection_type::abscissa_type	abscissa_type

typedef collection_type::ordinate_type	ordinate_type

typedef collection_type::value_type	value_type

typedef collection_type::distance_type	distance_type

typedef collection_type::const_iterator	const_iterator

typedef collection_type::const_reverse_iterator	const_reverse_iterator

typedef collection_type::iterator	iterator

typedef collection_type::reverse_iterator	reverse_iterator

typedef JFunction1D< abscissa_type, double >	function_type

typedef function_type::argument_type	argument_type

typedef function_type::result_type	result_type

typedef function_type::JExceptionHandler	exceptionhandler_type

enum

typedef JFunctional< JElement2D< double, double >::abscissa_type, double >	functional_type

typedef functional_type::JExceptionHandler	JExceptionHandler

typedef JSupervisor	supervisor_type

Public Member Functions
result_type	operator() (const argument_type x) const
	Function value evaluation.

const JSupervisor &	getSupervisor () const
	Get supervisor.

const JExceptionHandler &	getExceptionHandler () const override
	Get exception handler.

void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions.

virtual result_type	evaluate (const argument_type *pX) const=0
	Recursive function value evaluation.

const std::string &	getTitle () const
	Get title.

void	setTitle (const std::string &title)
	Set title.

Static Public Member Functions
static result_type	getValue (const JFunctional &function, const argument_type *pX)
	Recursive function value evaluation.

static JClass< result_type >::argument_type	getValue (typename JClass< result_type >::argument_type value, const argument_type *pX)
	Termination of recursive function value evaluation.

Protected Member Functions
	JNOAAFunction1D_t (const std::string &title)
	Constructor.

virtual void	do_compile () override
	Function compilation.

Protected Attributes
JSupervisor	__supervisor

std::string	title

Friends
std::ostream &	operator<< (std::ostream &out, const JNOAAFunction1D_t &object)
	Write function to output stream.

Detailed Description

Auxiliary base class for interpolation of magnetic declination data obtained from website of NOAA.

Definition at line 25 of file JNOAA.hh.

Member Typedef Documentation

◆ collection_type

JGridCollection<JElement2D< double, double >, JDistance<typename JElement2D< double, double >::abscissa_type>> JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::collection_type

inherited

Definition at line 1098 of file JPolint.hh.

◆ abscissa_type

collection_type::abscissa_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::abscissa_type

inherited

Definition at line 1100 of file JPolint.hh.

◆ ordinate_type

collection_type::ordinate_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::ordinate_type

inherited

Definition at line 1101 of file JPolint.hh.

◆ value_type

collection_type::value_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::value_type

inherited

Definition at line 1102 of file JPolint.hh.

◆ distance_type

collection_type::distance_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::distance_type

inherited

Definition at line 1103 of file JPolint.hh.

◆ const_iterator

collection_type::const_iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::const_iterator

inherited

Definition at line 1105 of file JPolint.hh.

◆ const_reverse_iterator

collection_type::const_reverse_iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::const_reverse_iterator

inherited

Definition at line 1106 of file JPolint.hh.

◆ iterator

collection_type::iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::iterator

inherited

Definition at line 1107 of file JPolint.hh.

◆ reverse_iterator

collection_type::reverse_iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::reverse_iterator

inherited

Definition at line 1108 of file JPolint.hh.

◆ function_type

JFunction1D<abscissa_type, double> JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::function_type

inherited

Definition at line 1110 of file JPolint.hh.

◆ argument_type

function_type::argument_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::argument_type

inherited

Definition at line 1112 of file JPolint.hh.

◆ result_type

function_type::result_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::result_type

inherited

Definition at line 1113 of file JPolint.hh.

◆ exceptionhandler_type

function_type::JExceptionHandler JTOOLS::JPolintFunction1D< N, JElement2D< double, double >, JGridCollection, double, JDistance<typename JElement2D< double, double >::abscissa_type> >::exceptionhandler_type

inherited

Definition at line 1114 of file JPolint.hh.

◆ functional_type

JFunctional<JElement2D< double, double >::abscissa_type, double> JTOOLS::JFunction1D< JElement2D< double, double >::abscissa_type, double >::functional_type

inherited

Definition at line 332 of file JFunctional.hh.

◆ JExceptionHandler

functional_type::JExceptionHandler JTOOLS::JFunction< JElement2D< double, double >::abscissa_type, double >::JExceptionHandler

inherited

Definition at line 235 of file JFunctional.hh.

◆ supervisor_type

JSupervisor JTOOLS::JFunction< JElement2D< double, double >::abscissa_type, double >::supervisor_type

inherited

Definition at line 237 of file JFunctional.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Definition at line 330 of file JFunctional.hh.

330{ NUMBER_OF_DIMENSIONS = 1 };

JTOOLS::JFunction1D< JElement2D< double, double >::abscissa_type, double >::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JFunctional.hh:330

Constructor & Destructor Documentation

◆ JNOAAFunction1D_t()

JCOMPASS::JNOAAFunction1D_t::JNOAAFunction1D_t ( const std::string & title )

inlineprotected

Constructor.

Parameters

title title

Definition at line 48 of file JNOAA.hh.

                                              :
      JTitle(title)
    {}

Member Function Documentation

◆ do_compile()

virtual void JCOMPASS::JNOAAFunction1D_t::do_compile ( )

inlineoverrideprotectedvirtual

Function compilation.

Convert degrees to radians.

Definition at line 58 of file JNOAA.hh.

    {
      using namespace JPP;
 
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() *= PI / 180.0;
      }
 
      JTOOLS::JGridPolint1Function1D_t::do_compile();
    }

◆ operator()()

result_type JTOOLS::JFunction1D< JElement2D< double, double >::abscissa_type, double >::operator() ( const argument_type x ) const

inlineinherited

Function value evaluation.

Parameters

x	argument value

Returns: function value

Definition at line 343 of file JFunctional.hh.

    {
      return this->evaluate(&x);
    }

◆ getSupervisor()

const JSupervisor & JTOOLS::JFunction< JElement2D< double, double >::abscissa_type, double >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 290 of file JFunctional.hh.

    {
      return __supervisor;
    }

◆ getExceptionHandler()

const JExceptionHandler & JTOOLS::JFunction< JElement2D< double, double >::abscissa_type, double >::getExceptionHandler ( ) const

inlineoverridevirtualinherited

Get exception handler.

Returns: exception handler

Implements JTOOLS::JFunctional< JElement2D< double, double >::abscissa_type, double >.

Definition at line 301 of file JFunctional.hh.

    {
      return *__supervisor.handler;
    }

◆ setExceptionHandler()

void JTOOLS::JFunction< JElement2D< double, double >::abscissa_type, double >::setExceptionHandler ( const JSupervisor & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 312 of file JFunctional.hh.

    {
      this->__supervisor = supervisor;
    }

◆ evaluate()

virtual result_type JTOOLS::JFunctional< JElement2D< double, double >::abscissa_type, double >::evaluate ( const argument_type * pX ) const

pure virtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

◆ getValue() [1/2]

static result_type JTOOLS::JFunctional< JElement2D< double, double >::abscissa_type, double >::getValue	(	const JFunctional< JElement2D< double, double >::abscissa_type, double > &	function,
		const argument_type *	pX )

inlinestaticinherited

Recursive function value evaluation.

Parameters

function	function
pX	pointer to abscissa values

Definition at line 103 of file JFunctional.hh.

    {
      return function.evaluate(pX);
    }

◆ getValue() [2/2]

static JClass< result_type >::argument_type JTOOLS::JFunctional< JElement2D< double, double >::abscissa_type, double >::getValue	(	typename JClass< result_type >::argument_type	value,
		const argument_type *	pX )

inlinestaticinherited

Termination of recursive function value evaluation.

Parameters

value	result
pX	pointer to abscissa values

Definition at line 117 of file JFunctional.hh.

    {
      return value;
    }

◆ getTitle()

const std::string & JLANG::JTitle::getTitle ( ) const

inlineinherited

Get title.

Returns: title

Definition at line 55 of file JTitle.hh.

    {
      return this->title;
    }

◆ setTitle()

void JLANG::JTitle::setTitle ( const std::string & title )

inlineinherited

Set title.

Parameters

title title

Definition at line 66 of file JTitle.hh.

    {
      this->title = title;
    }

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const JNOAAFunction1D_t &	object )

friend

Write function to output stream.

Parameters

out	output stream
object	function

Returns: output stream

Definition at line 36 of file JNOAA.hh.

    {
      return out << object.getTitle() << ' ' << "[" << FIXED(12,0) << object.getXmin() << "," << FIXED(12,0) << object.getXmax() << "]";
    }

Member Data Documentation

◆ __supervisor

JSupervisor JTOOLS::JFunction< JElement2D< double, double >::abscissa_type, double >::__supervisor

protectedinherited

Definition at line 318 of file JFunctional.hh.

◆ title

std::string JLANG::JTitle::title

protectedinherited

Definition at line 73 of file JTitle.hh.

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

JNOAA.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ collection_type

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ distance_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ function_type

◆ argument_type

◆ result_type

◆ exceptionhandler_type

◆ functional_type

◆ JExceptionHandler

◆ supervisor_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ JNOAAFunction1D_t()

Member Function Documentation

◆ do_compile()

◆ operator()()

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

◆ evaluate()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getTitle()

◆ setTitle()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ __supervisor

◆ title