JCOMPASS::JZEROMagneticDeclination Struct Reference

Fall back class for zero magnetic declination. More...

#include <JNOAA.hh>

Inheritance diagram for JCOMPASS::JZEROMagneticDeclination:

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 JSupervisor	supervisor_type

Public Member Functions
	JZEROMagneticDeclination ()
	Default constructor. More...
result_type	operator() (const argument_type x) const
	Function value evaluation. More...
virtual result_type	evaluate (const argument_type *pX) const =0
	Recursive function value evaluation. More...
JSupervisor	getSupervisor () const
	Get supervisor. More...
const JExceptionHandler &	getExceptionHandler () const
	Get exception handler. More...
void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions. More...
const std::string &	getTitle () const
	Get title. More...
void	setTitle (const std::string &title)
	Set title. More...

Static Public Member Functions
static result_type	getValue (const JFunctional &function, const argument_type *pX)
	Recursive function value evaluation. More...
static JClass< result_type > ::argument_type	getValue (typename JClass< result_type >::argument_type value, const argument_type *pX)
	Termination of recursive function value evaluation. More...

Protected Member Functions
virtual void	do_compile () override
	Function compilation. More...

Protected Attributes
JSupervisor	supervisor
std::string	title

Detailed Description

Fall back class for zero magnetic declination.

Definition at line 716 of file JNOAA.hh.

Member Typedef Documentation

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

typedef 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.

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

inherited

Definition at line 337 of file JFunctional.hh.

typedef JSupervisor JTOOLS::JFunctional< JElement2D< double, double >::abscissa_type , double >::supervisor_type

inherited

Definition at line 89 of file JFunctional.hh.

Member Enumeration Documentation

anonymous enum

inherited

Definition at line 335 of file JFunctional.hh.

{ NUMBER_OF_DIMENSIONS = 1 };

Constructor & Destructor Documentation

JCOMPASS::JZEROMagneticDeclination::JZEROMagneticDeclination ( )

inline

Default constructor.

Definition at line 722 of file JNOAA.hh.

                               :
      JNOAAFunction1D_t("zero")
    {
      this->setExceptionHandler(new JNOAAFunction1D_t::JDefaultResult(0.0));
    }

Member Function Documentation

virtual void JCOMPASS::JNOAAFunction1D_t::do_compile ( )

inlineoverrideprotectedvirtualinherited

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();
    }

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 348 of file JFunctional.hh.

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

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

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 107 of file JFunctional.hh.

    {
      return function.evaluate(pX);
    }

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 121 of file JFunctional.hh.

    {
      return value;
    }

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

inlineinherited

Get supervisor.

Returns

supervisor

Definition at line 281 of file JFunctional.hh.

    {
      return supervisor;
    }

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

inlineinherited

Get exception handler.

Returns

exception handler

Definition at line 292 of file JFunctional.hh.

    {
      return *supervisor;
    }

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

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor

supervisor

Definition at line 303 of file JFunctional.hh.

    {
      this->supervisor = supervisor;
    }

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

inlineinherited

Get title.

Returns

title

Definition at line 55 of file JTitle.hh.

    {
      return this->title;
    }

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;
    }

Member Data Documentation

JSupervisor JTOOLS::JFunctional< JElement2D< double, double >::abscissa_type , double >::supervisor

protectedinherited

Definition at line 310 of file JFunctional.hh.

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