srm::SRF_SolarMagneticDipole Class Reference

SRF_SolarMagneticDipole class declaration. More...

#include <SolarMagneticDipole.h>

Inheritance diagram for srm::SRF_SolarMagneticDipole:

[legend]Collaboration diagram for srm::SRF_SolarMagneticDipole:

[legend]List of all members.

Public Member Functions
Coord3D *	createCoordinate3D (SRM_Long_Float coord_comp1, SRM_Long_Float coord_comp2, SRM_Long_Float coord_comp3)
	Returns a 3D coordinate object.
virtual bool	isA (SRF_ClassType type) const
	Returns true if this SRF is of the given class type.
virtual SRF_ClassType	getClassType () const
	Returns the class type of this SRF instance.
bool	isEqual (const SRF_SolarMagneticDipole &srf) const
	Returns true is the SRF parameters are equal.
SRF_SolarMagneticDipole *	makeCopy () const
	Returns a copy of this SRF object.
const char *	toString ()
	Returns char* of parameter names and their values.
Static Public Member Functions
SRF_SolarMagneticDipole *	create (SRM_ORM_Code orm, SRM_RT_Code rt)
	SRF_SolarMagneticDipole only constructor by ORM code.
SRF_SolarMagneticDipole *	create (SRM_SRF_Parameters_Info srf_params)
	SRF_SolarMagneticDipole constructor by ORM parameters.
Protected Member Functions
	SRF_SolarMagneticDipole (void *impl)
	No stack allocation.
SRF_SolarMagneticDipole &	operator= (const BaseSRF &)
	No copy constructor.
virtual	~SRF_SolarMagneticDipole ()
	Use release().
Friends
class	BaseSRF
class	BaseSRF_3D
class	BaseSRF_WithEllipsoidalHeight

---

Detailed Description

SRF_SolarMagneticDipole class declaration.

SRFs are allocated by the API, and when no longer needed they should be released by calling the release() method.

Author:

David Shen

See also:

BaseSRF_3D

Definition at line 33 of file SolarMagneticDipole.h.

---

Member Function Documentation

SRF_SolarMagneticDipole* srm::SRF_SolarMagneticDipole::create (  SRM_SRF_Parameters_Info  srf_params  )  [inline, static]

SRF_SolarMagneticDipole constructor by ORM parameters. Exceptions: This  method throws srm::Exception Definition at line 46 of file SolarMagneticDipole.h.

SRF_SolarMagneticDipole* srm::SRF_SolarMagneticDipole::create (  SRM_ORM_Code  orm, SRM_RT_Code  rt )  [static]

SRF_SolarMagneticDipole only constructor by ORM code. Exceptions: This  method throws srm::Exception

SRF_SolarMagneticDipole* srm::SRF_SolarMagneticDipole::makeCopy (   )  const

Returns a copy of this SRF object. Exceptions: This  method throws srm::Exception

const char* srm::SRF_SolarMagneticDipole::toString (   )  [virtual]

Returns char* of parameter names and their values. Exceptions: This  method throws srm::Exception Implements srm::BaseSRF.

---

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

• SolarMagneticDipole.h

---

Spatial Reference Model C++ API	Version 4.1 - 26 Jun 2006
Copyright © 2006 SEDRIS™	Docs by Doxygen 1.3.2