クラス rcsc::AngleDeg

degree wrapper class [詳細]

#include <angle_deg.h>

すべてのメンバ一覧

Public メソッド

 AngleDeg ()
 default constructor.
 AngleDeg (const double &deg)
 constructor with value.
const AngleDegoperator= (const double &deg)
 operator substitution.
const double & degree () const
 get value of this angle
double abs () const
 get absolute value of this angle
double radian () const
 get RADIAN value.
AngleDeg operator- () const
 get new AngleDeg multiplyed by -1.
const AngleDegoperator+= (const AngleDeg &angle)
 operator += with AngleDeg
const AngleDegoperator+= (const double &deg)
 operator += with double
const AngleDegoperator-= (const AngleDeg &angle)
 operator -= with AngleDeg
const AngleDegoperator-= (const double &deg)
 operator -= with double
const AngleDegoperator *= (const double &scalar)
 operator *=
const AngleDegoperator/= (const double &scalar)
 operator /=
bool isLeftOf (const AngleDeg &angle) const
 check if this angle is left of 'angle'
bool isLeftEqualOf (const AngleDeg &angle) const
 check if this angle is left or equal of 'angle'
bool isRightOf (const AngleDeg &angle) const
 check if this angle is right of 'angle'
bool isRightEqualOf (const AngleDeg &angle) const
 check if this angle is right or equal of 'angle'
double cos () const
 calculate cosine
double sin () const
 calculate sine
double tan () const
 calculate tarngetn
bool isWithin (const AngleDeg &left, const AngleDeg &right) const
 check if this angle is within [left, right] (turn clockwise).
void sinMinMax (const double &angle_err, double *minsin, double *maxsin) const
 calculate min/max sine value with angle error.
void cosMinMax (const double &angle_err, double *mincos, double *maxcos) const
 calculate min/max cosine value of angle with angle error.
std::ostream & print (std::ostream &os) const
 output value to ostream
std::ostream & printRound (std::ostream &os, const double &step=0.1) const
 output rounded value to ostream

Static Public メソッド

static double normalize_angle (double dir)
 static utility. normalize angle
static double rad2deg (const double &rad)
 static utility. convert radian to degree
static double deg2rad (const double &deg)
 static utility. convert degree to radian
static double cos_deg (const double &deg)
 static utility. calculate cosine value for degree angle
static double sin_deg (const double &deg)
 static utility. calculate sine value for degree angle
static double tan_deg (const double &deg)
 static utility. calculate tangent value for degree angle
static double acos_deg (const double &cosine)
 static utility. calculate arc cosine value
static double asin_deg (const double &sine)
 static utility. calculate arc sine value
static double atan_deg (const double &tangent)
 static utility. calculate arc tangent value
static double atan2_deg (const double &y, const double &x)
 static utility. calculate arc tangent value from XY
static AngleDeg bisect (const AngleDeg &left, const AngleDeg &right)
 static utility that returns bisect angle of [left, right].

Static Public 変数

static const double EPSILON
 epsilon value
static const double DEG2RAD
 constant variable to convert DEGREE to RADIAN.
static const double RAD2DEG
 constant variable to convert RADIAN to DEGREE.

構成

class  DegreeCmp
 predicate function object. this compares two angles by degree value [詳細]


説明

degree wrapper class


コンストラクタとデストラクタ

rcsc::AngleDeg::AngleDeg ( const double &  deg  )  [inline]

constructor with value.

NO explicit. This means that we can use this class as follows. AngleDeg angle = 3.0;


関数

const AngleDeg& rcsc::AngleDeg::operator= ( const double &  deg  )  [inline]

operator substitution.

引数:
deg initialization parameter
戻り値:
const reference to itself

const double& rcsc::AngleDeg::degree (  )  const [inline]

get value of this angle

戻り値:
const reference to the member variable

double rcsc::AngleDeg::abs (  )  const [inline]

get absolute value of this angle

戻り値:
absolute value of degree()

double rcsc::AngleDeg::radian (  )  const [inline]

get RADIAN value.

戻り値:
radian value of degree()

AngleDeg rcsc::AngleDeg::operator- (  )  const [inline]

get new AngleDeg multiplyed by -1.

戻り値:
new AngleDeg object

const AngleDeg& rcsc::AngleDeg::operator+= ( const AngleDeg angle  )  [inline]

operator += with AngleDeg

引数:
angle added value
戻り値:
const reference to this

const AngleDeg& rcsc::AngleDeg::operator+= ( const double &  deg  )  [inline]

operator += with double

引数:
deg added value
戻り値:
const reference to this

const AngleDeg& rcsc::AngleDeg::operator-= ( const AngleDeg angle  )  [inline]

operator -= with AngleDeg

引数:
angle subtract argument
戻り値:
const reference to this

const AngleDeg& rcsc::AngleDeg::operator-= ( const double &  deg  )  [inline]

operator -= with double

引数:
deg subtract argument
戻り値:
const reference to this

const AngleDeg& rcsc::AngleDeg::operator *= ( const double &  scalar  )  [inline]

operator *=

引数:
scalar multiply argument
戻り値:
const reference to this

const AngleDeg& rcsc::AngleDeg::operator/= ( const double &  scalar  )  [inline]

operator /=

引数:
scalar division argument
戻り値:
const reference to this

bool rcsc::AngleDeg::isLeftOf ( const AngleDeg angle  )  const [inline]

check if this angle is left of 'angle'

戻り値:
true or false

bool rcsc::AngleDeg::isLeftEqualOf ( const AngleDeg angle  )  const [inline]

check if this angle is left or equal of 'angle'

戻り値:
true or false

bool rcsc::AngleDeg::isRightOf ( const AngleDeg angle  )  const [inline]

check if this angle is right of 'angle'

戻り値:
true or false

bool rcsc::AngleDeg::isRightEqualOf ( const AngleDeg angle  )  const [inline]

check if this angle is right or equal of 'angle'

戻り値:
true or false

double rcsc::AngleDeg::cos (  )  const [inline]

calculate cosine

戻り値:
cosine value

double rcsc::AngleDeg::sin (  )  const [inline]

calculate sine

戻り値:
sine value

double rcsc::AngleDeg::tan (  )  const [inline]

calculate tarngetn

戻り値:
tangent value

bool rcsc::AngleDeg::isWithin ( const AngleDeg left,
const AngleDeg right 
) const

check if this angle is within [left, right] (turn clockwise).

引数:
left left angle
right right angle
戻り値:
true if this is within [left, right]. else false

void rcsc::AngleDeg::sinMinMax ( const double &  angle_err,
double *  minsin,
double *  maxsin 
) const

calculate min/max sine value with angle error.

引数:
angle_err error value of angle
minsin pointer to the solution variable to store the min value
maxsin pointer to the solution variable to store the max value

void rcsc::AngleDeg::cosMinMax ( const double &  angle_err,
double *  mincos,
double *  maxcos 
) const

calculate min/max cosine value of angle with angle error.

引数:
angle_err error value of angle
mincos pointer to the solution variable to store the min value
maxcos pointer to the solution variable to store the max value

static double rcsc::AngleDeg::normalize_angle ( double  dir  )  [inline, static]

static utility. normalize angle

引数:
dir angle value to be normalized
戻り値:
normalized angle value

static double rcsc::AngleDeg::rad2deg ( const double &  rad  )  [inline, static]

static utility. convert radian to degree

引数:
rad radian value
戻り値:
degree value

static double rcsc::AngleDeg::deg2rad ( const double &  deg  )  [inline, static]

static utility. convert degree to radian

引数:
deg degree value
戻り値:
radian value

static double rcsc::AngleDeg::cos_deg ( const double &  deg  )  [inline, static]

static utility. calculate cosine value for degree angle

引数:
deg degree value
戻り値:
cosine value

static double rcsc::AngleDeg::sin_deg ( const double &  deg  )  [inline, static]

static utility. calculate sine value for degree angle

引数:
deg degree value
戻り値:
sine value

static double rcsc::AngleDeg::tan_deg ( const double &  deg  )  [inline, static]

static utility. calculate tangent value for degree angle

引数:
deg degree value
戻り値:
tangent value

static double rcsc::AngleDeg::acos_deg ( const double &  cosine  )  [inline, static]

static utility. calculate arc cosine value

引数:
cosine cosine value
戻り値:
arc cosine value, that is degree type.

static double rcsc::AngleDeg::asin_deg ( const double &  sine  )  [inline, static]

static utility. calculate arc sine value

引数:
sine sine value
戻り値:
arc sine value, that is degree type.

static double rcsc::AngleDeg::atan_deg ( const double &  tangent  )  [inline, static]

static utility. calculate arc tangent value

引数:
tangent tangent value
戻り値:
arc tangent value, that is degree.

static double rcsc::AngleDeg::atan2_deg ( const double &  y,
const double &  x 
) [inline, static]

static utility. calculate arc tangent value from XY

引数:
y coordinate Y
x coordinate X
戻り値:
arc tangent value, that is degree type.

AngleDeg rcsc::AngleDeg::bisect ( const AngleDeg left,
const AngleDeg right 
) [static]

static utility that returns bisect angle of [left, right].

引数:
left left start angle
right right end angle
戻り値:
bisect angle
this methid can take obtuse angle.

std::ostream& rcsc::AngleDeg::print ( std::ostream &  os  )  const [inline]

output value to ostream

引数:
os reference to the output stream
戻り値:
reference to the output stream

std::ostream& rcsc::AngleDeg::printRound ( std::ostream &  os,
const double &  step = 0.1 
) const [inline]

output rounded value to ostream

引数:
os reference to the output stream
step round step
戻り値:
reference to the output stream


このクラスの説明は次のファイルから生成されました:
librcscに対してThu May 1 15:41:26 2008に生成されました。  doxygen 1.5.0