psen_scan::PSENscanInternalAngle Class Reference

Class to model angles in PSENscan internal format (tenth of degrees) More...

#include <psen_scan_internal_angle.h>

Public Member Functions
	operator int () const noexcept
	Get the PSENscanInternalAngle as an integer. More...
bool	operator!= (const PSENscanInternalAngle &rhs) const
	Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object. More...
PSENscanInternalAngle	operator+ (const PSENscanInternalAngle &rhs) const
	Add a PSENscanInternalAngle object to another PSENscanInternalAngle. More...
PSENscanInternalAngle	operator+= (const PSENscanInternalAngle &rhs)
	Define adding a PSENscanInternalAngle object to another PSENscanInternalAngle. More...
PSENscanInternalAngle	operator- (const PSENscanInternalAngle &rhs) const
	Subtract a PSENscanInternalAngle object by another PSENscanInternalAngle. More...
PSENscanInternalAngle	operator- ()
	Unary Minus Operator to switch the sign of the Degree. More...
PSENscanInternalAngle	operator-= (const PSENscanInternalAngle &rhs)
	Define subtracting a PSENscanInternalAngle object by another PSENscanInternalAngle. More...
bool	operator< (const PSENscanInternalAngle &rhs) const
	Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object. More...
bool	operator<= (const PSENscanInternalAngle &rhs) const
	Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object. More...
PSENscanInternalAngle &	operator= (const PSENscanInternalAngle &rhs)=default
bool	operator== (const PSENscanInternalAngle &rhs) const
	Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object. More...
bool	operator> (const PSENscanInternalAngle &rhs) const
	Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object. More...
bool	operator>= (const PSENscanInternalAngle &rhs) const
	Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object. More...
	PSENscanInternalAngle (const PSENscanInternalAngle &angle)
	Construct a new PSENscanInternalAngle::PSENscanInternalAngle object from another PSENscanInternalAngle object. More...
	PSENscanInternalAngle (const int &angle)
	Construct a new PSENscanInternalAngle::PSENscanInternalAngle object from an Integer. More...
	PSENscanInternalAngle (const Degree &angle)
	Construct a new PSENscanInternalAngle::PSENscanInternalAngle object from a Degree object. More...

Private Attributes
int	angle_

Friends
std::ostream &	operator<< (std::ostream &os, const PSENscanInternalAngle &deg)
	Define how PSENscanInternalAngle should behave with stream operator. More...

Detailed Description

Class to model angles in PSENscan internal format (tenth of degrees)

Definition at line 55 of file psen_scan_internal_angle.h.

Constructor & Destructor Documentation

PSENscanInternalAngle() [1/3]

psen_scan::PSENscanInternalAngle::PSENscanInternalAngle

(

const PSENscanInternalAngle &

angle

)

Construct a new PSENscanInternalAngle::PSENscanInternalAngle object from another PSENscanInternalAngle object.

Parameters

angle

PSENscanInternalAngle object to copy the angle from.

Definition at line 170 of file psen_scan_internal_angle.cpp.

PSENscanInternalAngle() [2/3]

psen_scan::PSENscanInternalAngle::PSENscanInternalAngle ( const int &  angle )

explicit

Construct a new PSENscanInternalAngle::PSENscanInternalAngle object from an Integer.

Parameters

angle

Definition at line 179 of file psen_scan_internal_angle.cpp.

PSENscanInternalAngle() [3/3]

psen_scan::PSENscanInternalAngle::PSENscanInternalAngle ( const Degree &  angle )

explicit

Construct a new PSENscanInternalAngle::PSENscanInternalAngle object from a Degree object.

Parameters

angle

Degree object to get the angle from and convert it to PSENscanInternalAngle.

Definition at line 188 of file psen_scan_internal_angle.cpp.

Member Function Documentation

operator int()

psen_scan::PSENscanInternalAngle::operator int ( ) const

explicitnoexcept

Get the PSENscanInternalAngle as an integer.

Returns

int Integer representation of PSENscanInternalAngle.

Definition at line 202 of file psen_scan_internal_angle.cpp.

operator!=()

bool psen_scan::PSENscanInternalAngle::operator!=

(

const PSENscanInternalAngle &

rhs

)

const

Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object.

Parameters

rhs	PSENscanInternalAngle object to be compared with

Returns

bool

Definition at line 268 of file psen_scan_internal_angle.cpp.

operator+()

PSENscanInternalAngle psen_scan::PSENscanInternalAngle::operator+

(

const PSENscanInternalAngle &

rhs

)

const

Add a PSENscanInternalAngle object to another PSENscanInternalAngle.

Parameters

rhs	PSENscanInternalAngle to add the angle to.

Returns

PSENscanInternalAngle

Definition at line 328 of file psen_scan_internal_angle.cpp.

operator+=()

PSENscanInternalAngle psen_scan::PSENscanInternalAngle::operator+=

(

const PSENscanInternalAngle &

rhs

)

Define adding a PSENscanInternalAngle object to another PSENscanInternalAngle.

Parameters

rhs	PSENscanInternalAngle to add the angle to.

Returns

PSENscanInternalAngle

Definition at line 316 of file psen_scan_internal_angle.cpp.

operator-() [1/2]

PSENscanInternalAngle psen_scan::PSENscanInternalAngle::operator-

(

const PSENscanInternalAngle &

rhs

)

const

Subtract a PSENscanInternalAngle object by another PSENscanInternalAngle.

Parameters

rhs	PSENscanInternalAngle to subtract the angle by.

Returns

PSENscanInternalAngle

Definition at line 291 of file psen_scan_internal_angle.cpp.

operator-() [2/2]

PSENscanInternalAngle psen_scan::PSENscanInternalAngle::operator-

(

)

Unary Minus Operator to switch the sign of the Degree.

Returns

PSENscanInternalAngle

Definition at line 303 of file psen_scan_internal_angle.cpp.

operator-=()

PSENscanInternalAngle psen_scan::PSENscanInternalAngle::operator-=

(

const PSENscanInternalAngle &

rhs

)

Define subtracting a PSENscanInternalAngle object by another PSENscanInternalAngle.

Parameters

rhs	PSENscanInternalAngle to subtract the angle by.

Returns

PSENscanInternalAngle

Definition at line 279 of file psen_scan_internal_angle.cpp.

operator<()

bool psen_scan::PSENscanInternalAngle::operator<

(

const PSENscanInternalAngle &

rhs

)

const

Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object.

Parameters

rhs	PSENscanInternalAngle object to be compared with

Returns

bool

Definition at line 213 of file psen_scan_internal_angle.cpp.

operator<=()

bool psen_scan::PSENscanInternalAngle::operator<=

(

const PSENscanInternalAngle &

rhs

)

const

Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object.

Parameters

rhs	PSENscanInternalAngle object to be compared with

Returns

bool

Definition at line 235 of file psen_scan_internal_angle.cpp.

operator=()

PSENscanInternalAngle& psen_scan::PSENscanInternalAngle::operator= ( const PSENscanInternalAngle &  rhs )

default

operator==()

bool psen_scan::PSENscanInternalAngle::operator==

(

const PSENscanInternalAngle &

rhs

)

const

Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object.

Parameters

rhs	PSENscanInternalAngle object to be compared with

Returns

bool

Definition at line 257 of file psen_scan_internal_angle.cpp.

operator>()

bool psen_scan::PSENscanInternalAngle::operator>

(

const PSENscanInternalAngle &

rhs

)

const

Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object.

Parameters

rhs	PSENscanInternalAngle object to be compared with

Returns

bool

Definition at line 224 of file psen_scan_internal_angle.cpp.

operator>=()

bool psen_scan::PSENscanInternalAngle::operator>=

(

const PSENscanInternalAngle &

rhs

)

const

Compare a PSENscanInternalAngle object with another PSENscanInternalAngle object.

Parameters

rhs	PSENscanInternalAngle object to be compared with

Returns

bool

Definition at line 246 of file psen_scan_internal_angle.cpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const PSENscanInternalAngle &  deg  )

friend

Define how PSENscanInternalAngle should behave with stream operator.

Parameters

os	Output Stream
deg	PSENscanInternalAngle

Returns

std::ostream& Reference to Output Stream

Definition at line 342 of file psen_scan_internal_angle.cpp.

Member Data Documentation

angle_

int psen_scan::PSENscanInternalAngle::angle_

private

Definition at line 58 of file psen_scan_internal_angle.h.

---

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

• psen_scan_internal_angle.h
• psen_scan_internal_angle.cpp