NETGeographicLib::SphericalCoefficients Class Reference

.NET wrapper for GeographicLib::SphericalEngine::coeff. More...

#include <NETGeographicLib/SphericalCoefficients.h>

List of all members.

Public Member Functions
	SphericalCoefficients (const GeographicLib::SphericalEngine::coeff &c)
	Constructor.
int	index (int n, int m)
double	Cv (int k)
double	Sv (int k)
double	Cv (int k, int n, int m, double f)
double	Sv (int k, int n, int m, double f)
Static Public Member Functions
static int	Csize (int N, int M)
static int	Ssize (int N, int M)
Properties
int	N [get]
int	nmx [get]
int	mmx [get]

---

Detailed Description

.NET wrapper for GeographicLib::SphericalEngine::coeff.

This class allows .NET applications to access GeographicLib::SphericalEngine::coeff.

The SphericalHarmonic classes provide accessor functions that allow you to examine the coefficients. These accessor functions export a GeographicLib::SphericalEngine::coeff object. The GeographicLib::SphericalEngine class is not implemented in NETGeographicLib. SphericalCoefficients is provided as a substitute for GeographicLib::SphericalEngine::coeff allowing you to examine the coefficients in .NET applications.

Use SphericalHarmonic::Coefficients, SphericalHarmonic1::Coefficient*, or SphericalHarmonic2::Coefficient* to obtain an instance of this class.

INTERFACE DIFFERENCES:
This class does not implement readcoeffs.

Definition at line 34 of file SphericalCoefficients.h.

---

Constructor & Destructor Documentation

NETGeographicLib::SphericalCoefficients::SphericalCoefficients

(

const GeographicLib::SphericalEngine::coeff &

c

)

Constructor.

Parameters:

[in]

c

A reference to a GeographicLib::SphericalEngine::coeff object. This constructor is for internal use only. Developers should not create an instance of SphericalCoefficients. Use SphericalHarmonic::Coefficients, SphericalHarmonic1::Coefficient*, or SphericalHarmonic2::Coefficient* to obtain an instance of this class.

---

Member Function Documentation

int NETGeographicLib::SphericalCoefficients::index	(	int	n,
		int	m
	)			[inline]

The one-dimensional index into C and S.

Parameters:

[in]	n	the degree.
[in]	m	the order.

Returns:

the one-dimensional index.

Definition at line 76 of file SphericalCoefficients.h.

double NETGeographicLib::SphericalCoefficients::Cv

(

int

k

)

[inline]

An element of C.

Parameters:

[in]

k

the one-dimensional index.

Returns:

the value of the C coefficient.

Definition at line 84 of file SphericalCoefficients.h.

double NETGeographicLib::SphericalCoefficients::Sv

(

int

k

)

[inline]

An element of S.

Parameters:

[in]

k

the one-dimensional index.

Returns:

the value of the S coefficient.

Definition at line 91 of file SphericalCoefficients.h.

double NETGeographicLib::SphericalCoefficients::Cv	(	int	k,
		int	n,
		int	m,
		double	f
	)			[inline]

An element of C with checking.

Parameters:

[in]	k	the one-dimensional index.
[in]	n	the requested degree.
[in]	m	the requested order.
[in]	f	a multiplier.

Returns:

the value of the C coefficient multiplied by f in n and m are in range else 0.

Definition at line 102 of file SphericalCoefficients.h.

double NETGeographicLib::SphericalCoefficients::Sv	(	int	k,
		int	n,
		int	m,
		double	f
	)			[inline]

An element of S with checking.

Parameters:

[in]	k	the one-dimensional index.
[in]	n	the requested degree.
[in]	m	the requested order.
[in]	f	a multiplier.

Returns:

the value of the S coefficient multiplied by f in n and m are in range else 0.

Definition at line 114 of file SphericalCoefficients.h.

static int NETGeographicLib::SphericalCoefficients::Csize	(	int	N,
		int	M
	)			[inline, static]

The size of the coefficient vector for the cosine terms.

Parameters:

[in]	N	the maximum degree.
[in]	M	the maximum order.

Returns:

the size of the vector of cosine terms as stored in column major order.

Definition at line 125 of file SphericalCoefficients.h.

Referenced by Ssize().

static int NETGeographicLib::SphericalCoefficients::Ssize	(	int	N,
		int	M
	)			[inline, static]

The size of the coefficient vector for the sine terms.

Parameters:

[in]	N	the maximum degree.
[in]	M	the maximum order.

Returns:

the size of the vector of cosine terms as stored in column major order.

Definition at line 136 of file SphericalCoefficients.h.

References Csize().

---

Property Documentation

int NETGeographicLib::SphericalCoefficients::N [get]

Returns:

N the degree giving storage layout for C and S.

Definition at line 60 of file SphericalCoefficients.h.

int NETGeographicLib::SphericalCoefficients::nmx [get]

Returns:

nmx the maximum degree to be used.

Definition at line 64 of file SphericalCoefficients.h.

int NETGeographicLib::SphericalCoefficients::mmx [get]

Returns:

mmx the maximum order to be used.

Definition at line 68 of file SphericalCoefficients.h.

---

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

• SphericalCoefficients.h