src/FDM/JSBSim/math/FGColumnVector3.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3 Module: FGColumnVector3.cpp
   4 Author: Originally by Tony Peden [formatted here by JSB]
   5 Date started: 1998
   6 Purpose: FGColumnVector3 class
   7 Called by: Various
   8
   9  ------------- Copyright (C) 1998 Tony Peden and Jon S. Berndt (jon@jsbsim.org) -
  10
  11  This program is free software; you can redistribute it and/or modify it under
  12  the terms of the GNU Lesser General Public License as published by the Free Software
  13  Foundation; either version 2 of the License, or (at your option) any later
  14  version.
  15
  16  This program is distributed in the hope that it will be useful, but WITHOUT
  17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  19  details.
  20
  21  You should have received a copy of the GNU Lesser General Public License along with
  22  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  23  Place - Suite 330, Boston, MA  02111-1307, USA.
  24
  25  Further information about the GNU Lesser General Public License can also be found on
  26  the world wide web at http://www.gnu.org.
  27
  28 FUNCTIONAL DESCRIPTION
  29 --------------------------------------------------------------------------------
  30
  31 HISTORY
  32 --------------------------------------------------------------------------------
  33 ??/??/??   TP   Created
  34 03/16/2000 JSB  Added exception throwing
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 INCLUDES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #include "FGColumnVector3.h"
  41 #include <iostream>
  42 #include <sstream>
  43 #include <iomanip>
  44 #include <cmath>
  45
  46 using namespace std;
  47
  48 namespace JSBSim {
  49
  50 static const char *IdSrc = "$Id$";
  51 static const char *IdHdr = ID_COLUMNVECTOR3;
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 CLASS IMPLEMENTATION
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 FGColumnVector3::FGColumnVector3(void)
  58 {
  59   data[0] = data[1] = data[2] = 0.0;
  60   // Debug(0);
  61 }
  62
  63 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  64
  65 string FGColumnVector3::Dump(const string& delimiter) const
  66 {
  67   ostringstream buffer;
  68   buffer << std::setw(18) << std::setprecision(16) << Entry(1) << delimiter;
  69   buffer << std::setw(18) << std::setprecision(16) << Entry(2) << delimiter;
  70   buffer << std::setw(18) << std::setprecision(16) << Entry(3);
  71   return buffer.str();
  72 }
  73
  74 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  75
  76 ostream& operator<<(ostream& os, const FGColumnVector3& col)
  77 {
  78   os << col(1) << " , " << col(2) << " , " << col(3);
  79   return os;
  80 }
  81
  82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83
  84 FGColumnVector3 FGColumnVector3::operator/(const double scalar) const
  85 {
  86   if (scalar != 0.0)
  87     return operator*( 1.0/scalar );
  88
  89   cerr << "Attempt to divide by zero in method \
  90     FGColumnVector3::operator/(const double scalar), \
  91     object " << data[0] << " , " << data[1] << " , " << data[2] << endl;
  92   return FGColumnVector3();
  93 }
  94
  95 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  96
  97 FGColumnVector3& FGColumnVector3::operator/=(const double scalar)
  98 {
  99   if (scalar != 0.0)
 100     operator*=( 1.0/scalar );
 101   else
 102     cerr << "Attempt to divide by zero in method \
 103       FGColumnVector3::operator/=(const double scalar), \
 104       object " << data[0] << " , " << data[1] << " , " << data[2] << endl;
 105
 106   return *this;
 107 }
 108
 109 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 110
 111 double FGColumnVector3::Magnitude(void) const
 112 {
 113   if (Entry(1) == 0.0 && Entry(2) == 0.0 && Entry(3) == 0.0)
 114     return 0.0;
 115   else
 116     return sqrt( Entry(1)*Entry(1) +  Entry(2)*Entry(2) +  Entry(3)*Entry(3) );
 117 }
 118
 119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 120
 121 FGColumnVector3& FGColumnVector3::Normalize(void)
 122 {
 123   double Mag = Magnitude();
 124
 125   if (Mag != 0.0)
 126     operator*=( 1.0/Mag );
 127
 128   return *this;
 129 }
 130
 131 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 132 //    The bitmasked value choices are as follows:
 133 //    unset: In this case (the default) JSBSim would only print
 134 //       out the normally expected messages, essentially echoing
 135 //       the config files as they are read. If the environment
 136 //       variable is not set, debug_lvl is set to 1 internally
 137 //    0: This requests JSBSim not to output any messages
 138 //       whatsoever.
 139 //    1: This value explicity requests the normal JSBSim
 140 //       startup messages
 141 //    2: This value asks for a message to be printed out when
 142 //       a class is instantiated
 143 //    4: When this value is set, a message is displayed when a
 144 //       FGModel object executes its Run() method
 145 //    8: When this value is set, various runtime state variables
 146 //       are printed out periodically
 147 //    16: When set various parameters are sanity checked and
 148 //       a message is printed out when they go out of bounds
 149
 150 void FGColumnVector3::Debug(int from)
 151 {
 152   if (debug_lvl <= 0) return;
 153
 154   if (debug_lvl & 1) { // Standard console startup message output
 155   }
 156   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 157     if (from == 0) cout << "Instantiated: FGColumnVector3" << endl;
 158     if (from == 1) cout << "Destroyed:    FGColumnVector3" << endl;
 159   }
 160   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 161   }
 162   if (debug_lvl & 8 ) { // Runtime state variables
 163   }
 164   if (debug_lvl & 16) { // Sanity checking
 165   }
 166   if (debug_lvl & 64) {
 167     if (from == 0) { // Constructor
 168       cout << IdSrc << endl;
 169       cout << IdHdr << endl;
 170     }
 171   }
 172 }
 173
 174 } // namespace JSBSim