FGColumnVector3 Class Reference

#include <FGColumnVector3.h>

Inherits FGJSBBase.

List of all members.


Detailed Description

Author:
Jon S. Berndt, Tony Peden, et. al.
Version:
Id
FGColumnVector3.h,v 1.9 2008/07/22 02:42:17 jberndt Exp

Definition at line 83 of file FGColumnVector3.h.


Public Member Functions

string Dump (string delimeter) const
 Prints the contents of the vector.
double & Entry (unsigned int idx)
 Write access the entries of the vector.
double Entry (unsigned int idx) const
 Read access the entries of the vector.
 FGColumnVector3 (const FGColumnVector3 &v)
 Copy constructor.
 FGColumnVector3 (double X, double Y, double Z)
 Initialization by given values.
 FGColumnVector3 (void)
 Default initializer.
void InitMatrix (double a, double b, double c)
void InitMatrix (double a)
void InitMatrix (void)
double Magnitude (int idx1, int idx2) const
 Length of the vector in a coordinate axis plane.
double Magnitude (void) const
 Length of the vector.
FGColumnVector3Normalize (void)
 Normalize.
bool operator!= (const FGColumnVector3 &b) const
 Comparison operator.
double & operator() (unsigned int idx)
 Write access the entries of the vector.
double operator() (unsigned int idx) const
 Read access the entries of the vector.
FGColumnVector3 operator* (const FGColumnVector3 &V) const
 Cross product multiplication.
FGColumnVector3 operator* (const double scalar) const
 Multiplication by a scalar.
FGColumnVector3operator*= (const double scalar)
 Scale by a scalar.
FGColumnVector3 operator+ (const FGColumnVector3 &B) const
 Addition operator.
FGColumnVector3operator+= (const FGColumnVector3 &B)
 Add an other vector.
FGColumnVector3 operator- (const FGColumnVector3 &B) const
 Subtraction operator.
FGColumnVector3operator-= (const FGColumnVector3 &B)
 Subtract an other vector.
FGColumnVector3 operator/ (const double scalar) const
 Multiply by 1/scalar.
FGColumnVector3operator/= (const double scalar)
 Scale by a 1/scalar.
AssignRef operator<< (const double ff)
FGColumnVector3operator= (const FGColumnVector3 &b)
 Assignment operator.
bool operator== (const FGColumnVector3 &b) const
 Comparison operator.
 ~FGColumnVector3 (void)
 Destructor.

Classes

struct  AssignRef

Constructor & Destructor Documentation

FGColumnVector3 ( void   ) 

Create a zero vector.

Definition at line 52 of file FGColumnVector3.cpp.

FGColumnVector3 ( double  X,
double  Y,
double  Z 
) [inline]

Parameters:
X value of the x-conponent.
Y value of the y-conponent.
Z value of the z-conponent. Create a vector from the doubles given in the arguments.

Definition at line 95 of file FGColumnVector3.h.

FGColumnVector3 ( const FGColumnVector3 v  )  [inline]

Parameters:
v Vector which is used for initialization. Create copy of the vector given in the argument.

Definition at line 105 of file FGColumnVector3.h.


Member Function Documentation

string Dump ( string  delimeter  )  const

Parameters:
delimeter the item separator (tab or comma)
Returns:
a string with the delimeter-separated contents of the vector

Definition at line 60 of file FGColumnVector3.cpp.

double& Entry ( unsigned int  idx  )  [inline]

Parameters:
idx the component index. Return a reference to the vector entry at the given index. Indices are counted starting with 1. This function is just a shortcut for the double& operator()(unsigned int idx) function. It is used internally to access the elements in a more convenient way. Note that the index given in the argument is unchecked.

Definition at line 147 of file FGColumnVector3.h.

double Entry ( unsigned int  idx  )  const [inline]

Parameters:
idx the component index. Return the value of the matrix entry at the given index. Indices are counted starting with 1. This function is just a shortcut for the double operator()(unsigned int idx) const function. It is used internally to access the elements in a more convenient way. Note that the index given in the argument is unchecked.

Definition at line 137 of file FGColumnVector3.h.

double Magnitude ( int  idx1,
int  idx2 
) const [inline]

Compute and return the euclidean norm of this vector projected into the coordinate axis plane idx1-idx2.

Definition at line 251 of file FGColumnVector3.h.

double Magnitude ( void   )  const

Compute and return the euclidean norm of this vector.

Definition at line 104 of file FGColumnVector3.cpp.

FGColumnVector3 & Normalize ( void   ) 

Normalize the vector to have the Magnitude() == 1.0. If the vector is equal to zero it is left untouched.

Definition at line 114 of file FGColumnVector3.cpp.

bool operator!= ( const FGColumnVector3 b  )  const [inline]

Parameters:
b other vector. Returns false if both vectors are exactly the same.

Definition at line 174 of file FGColumnVector3.h.

double& operator() ( unsigned int  idx  )  [inline]

Parameters:
idx the component index. Return a reference to the vector entry at the given index. Indices are counted starting with 1. Note that the index given in the argument is unchecked.

Definition at line 127 of file FGColumnVector3.h.

double operator() ( unsigned int  idx  )  const [inline]

Parameters:
idx the component index. Return the value of the matrix entry at the given index. Indices are counted starting with 1. Note that the index given in the argument is unchecked.

Definition at line 120 of file FGColumnVector3.h.

FGColumnVector3 operator* ( const FGColumnVector3 V  )  const [inline]

Parameters:
V vector to multiply with.
Returns:
The resulting vector from the cross product multiplication. Compute and return the cross product of the current vector with the given argument.

Definition at line 195 of file FGColumnVector3.h.

FGColumnVector3 operator* ( const double  scalar  )  const [inline]

Parameters:
scalar scalar value to multiply the vector with.
Returns:
The resulting vector from the multiplication with that scalar. Multiply the vector with the scalar given in the argument.

Definition at line 180 of file FGColumnVector3.h.

FGColumnVector3 operator/ ( const double  scalar  )  const

Parameters:
scalar scalar value to devide the vector through.
Returns:
The resulting vector from the division through that scalar. Multiply the vector with the 1/scalar given in the argument.

Definition at line 77 of file FGColumnVector3.cpp.

FGColumnVector3& operator= ( const FGColumnVector3 b  )  [inline]

Parameters:
b source vector. Copy the content of the vector given in the argument into *this.

Definition at line 157 of file FGColumnVector3.h.

bool operator== ( const FGColumnVector3 b  )  const [inline]

Parameters:
b other vector. Returns true if both vectors are exactly the same.

Definition at line 167 of file FGColumnVector3.h.


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

Generated on Tue May 26 00:55:09 2009 for JSBSim Flight Dynamics Model by  doxygen 1.5.5