SolarMagneticDipole.h

Go to the documentation of this file.

// SRM SDK Release 4.4.0 - December 7, 2009

// - SRM spec. 4.4

/*
 *                             NOTICE
 * 
 * This software is provided openly and freely for use in representing and
 * interchanging environmental data & databases.
 * 
 * This software was developed for use by the United States Government with
 * unlimited rights.  The software was developed under contract
 * DASG60-02-D-0006 TO-193 by Science Applications International Corporation.
 * The software is unclassified and is deemed as Distribution A, approved
 * for Public Release.
 * 
 * Use by others is permitted only upon the ACCEPTANCE OF THE TERMS AND
 * CONDITIONS, AS STIPULATED UNDER THE FOLLOWING PROVISIONS:
 * 
 *    1. Recipient may make unlimited copies of this software and give
 *       copies to other persons or entities as long as the copies contain
 *       this NOTICE, and as long as the same copyright notices that
 *       appear on, or in, this software remain.
 * 
 *    2. Trademarks. All trademarks belong to their respective trademark
 *       holders.  Third-Party applications/software/information are
 *       copyrighted by their respective owners.
 * 
 *    3. Recipient agrees to forfeit all intellectual property and
 *       ownership rights for any version created from the modification
 *       or adaptation of this software, including versions created from
 *       the translation and/or reverse engineering of the software design.
 * 
 *    4. Transfer.  Recipient may not sell, rent, lease, or sublicense
 *       this software.  Recipient may, however enable another person
 *       or entity the rights to use this software, provided that this
 *       AGREEMENT and NOTICE is furnished along with the software and
 *       /or software system utilizing this software.
 * 
 *       All revisions, modifications, created by the Recipient, to this
 *       software and/or related technical data shall be forwarded by the
 *       Recipient to the Government at the following address:
 * 
 *         SMDC
 *         Attention SEDRIS (TO193) TPOC
 *         P.O. Box 1500
 *         Hunstville, AL  35807-3801
 * 
 *         or via electronic mail to:  [email protected]
 * 
 *    5. No Warranty. This software is being delivered to you AS IS
 *       and there is no warranty, EXPRESS or IMPLIED, as to its use
 *       or performance.
 * 
 *       The RECIPIENT ASSUMES ALL RISKS, KNOWN AND UNKNOWN, OF USING
 *       THIS SOFTWARE.  The DEVELOPER EXPRESSLY DISCLAIMS, and the
 *       RECIPIENT WAIVES, ANY and ALL PERFORMANCE OR RESULTS YOU MAY
 *       OBTAIN BY USING THIS SOFTWARE OR DOCUMENTATION.  THERE IS
 *       NO WARRANTY, EXPRESS OR, IMPLIED, AS TO NON-INFRINGEMENT OF
 *       THIRD PARTY RIGHTS, MERCHANTABILITY, OR FITNESS FOR ANY
 *       PARTICULAR PURPOSE.  IN NO EVENT WILL THE DEVELOPER, THE
 *       UNITED STATES GOVERNMENT OR ANYONE ELSE ASSOCIATED WITH THE
 *       DEVELOPMENT OF THIS SOFTWARE BE HELD LIABLE FOR ANY CONSEQUENTIAL,
 *       INCIDENTAL OR SPECIAL DAMAGES, INCLUDING ANY LOST PROFITS
 *       OR LOST SAVINGS WHATSOEVER.
 */

// SRM_OTHERS_GOES_HERE

// $Id: SolarMagneticDipole.h,v 1.18 2009/10/02 19:30:25 worleym Exp $

#ifndef _SolarMagneticDipole_h
#define _SolarMagneticDipole_h

#include "BaseSRF.h"
#include "Coord.h"
#include "Exception.h"

namespace srm
{
class EXPORT_SRM_CPP_DLL SRF_SolarMagneticDipole: public BaseSRF_3D
{
public:
      static SRF_SolarMagneticDipole* create( SRM_ORM_Code orm,
                                              SRM_RT_Code  rt );

      static SRF_SolarMagneticDipole* create( SRM_SRF_Parameters_Info srf_params )
      {
          return create( srf_params.value.srf_template.orm_code, srf_params.rt_code );
      }

      Coord3D* createCoordinate3D(SRM_Long_Float coord_comp1,
                                  SRM_Long_Float coord_comp2,
                                  SRM_Long_Float coord_comp3 );

      virtual bool isA( SRF_ClassType type ) const;

      virtual SRF_ClassType getClassType() const
      {
          return BaseSRF::SRF_TYP_SMD;
      }

      bool isEqual( const SRF_SolarMagneticDipole &srf ) const;

      bool operator==( const SRF_SolarMagneticDipole &rhs ) const;

      SRF_SolarMagneticDipole* makeCopy() const;

      const char* toString();

protected:
      SRF_SolarMagneticDipole( void *impl ) : BaseSRF_3D(impl) {} 
      SRF_SolarMagneticDipole &operator =( const SRF_SolarMagneticDipole & ) { return *this; } 
      virtual ~SRF_SolarMagneticDipole() {} 
};


inline bool SRF_SolarMagneticDipole::isA( SRF_ClassType type ) const
{
    if (type == BaseSRF::SRF_TYP_SMD)
        return true;
    else
        return BaseSRF_3D::isA(type);
};


typedef SRF_SolarMagneticDipole SRF_SMD;


class EXPORT_SRM_CPP_DLL Coord3D_SolarMagneticDipole: public Coord3D
{
public:
    Coord3D_SolarMagneticDipole(SRF_SolarMagneticDipole *srf,
                                SRM_Long_Float u = 0.0,
                                SRM_Long_Float v = 0.0,
                                SRM_Long_Float w = 0.0 )
    : Coord3D(srf)
    {
        setComponentValues(u, v, w);
    }

    Coord3D_SolarMagneticDipole( const Coord3D_SolarMagneticDipole &coord )
    : Coord3D(coord._srf)
    {
        setComponentValues( coord._values[0], coord._values[1], coord._values[2] );
    }

    void copyTo( Coord3D_SolarMagneticDipole &coord ) const
    {
        if (coord._srf != _srf)
            throw Exception( SRM_STATCOD_INVALID_SOURCE_COORDINATE, "copyTo: Coordinate associated with a difference SRF" );

        coord._values[0] = _values[0];
        coord._values[1] = _values[1];
        coord._values[2] = _values[2];
    }

    bool isEqual( const Coord3D_SolarMagneticDipole &coord ) const
    {
        return (_srf == coord._srf &&
                _values[0] == coord._values[0] &&
                _values[1] == coord._values[1] &&
                _values[2] == coord._values[2] );
    }

    void setComponentValues( SRM_Long_Float u, SRM_Long_Float v, SRM_Long_Float w )
    {
        _values[0] = u;
        _values[1] = v;
        _values[2] = w;
    }

    SRM_Long_Float get_u() const
    {
        return _values[0];
    }

    SRM_Long_Float get_v() const
    {
        return _values[1];
    }

    SRM_Long_Float get_w() const
    {
        return _values[2];
    }

    void set_u( SRM_Long_Float value )
    {
        _values[0] = value;
    }

    void set_v( SRM_Long_Float value )
    {
        _values[1] = value;
    }

    void set_w( SRM_Long_Float value )
    {
        _values[2] = value;
    }

    virtual bool isA( Coord_ClassType type ) const;

    virtual Coord_ClassType getClassType() const
    {
        return Coord::COORD_TYP_SMD;
    }

    bool operator==( const Coord3D_SolarMagneticDipole &rhs ) const;

    bool isCompatibleWith( const Coord3D_SolarMagneticDipole &rhs ) const
    {
        return ((*(SRF_SolarMagneticDipole*)(this->_srf)) == (*(SRF_SolarMagneticDipole*)(rhs._srf)));
    }

    Coord3D_SolarMagneticDipole &operator= ( const Coord3D_SolarMagneticDipole &rhs )
    {
        if((*(SRF_SolarMagneticDipole*)(this->_srf)) == (*(SRF_SolarMagneticDipole*)(rhs._srf)))
        {
            _values[0] = rhs._values[0];
            _values[1] = rhs._values[1];
            _values[2] = rhs._values[2];
        }
        else
            throw Exception(SRM_STATCOD_INVALID_TARGET_COORDINATE,
                            "Coord3D_SolarMagneticDipole op=: incompatible rhs coordinate");

        return *this;
    }
};


inline bool Coord3D_SolarMagneticDipole::isA( Coord_ClassType type ) const
{
    if (type == Coord::COORD_TYP_SMD)
        return true;
    else
        return Coord3D::isA(type);
};


typedef Coord3D_SolarMagneticDipole Coord3D_SMD;

} // namespace srm

#endif // _SolarMagneticDipole_h

---

Spatial Reference Model C++ API	Version 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™	Docs by Doxygen 1.3.2