trax::Orientation Struct Reference

Provides two values for orientation. More...

#include <C:/Trend/Development/Trax3/Code/trax/Orientation.h>

Public Types
enum class	Value : char { none = -1 , anti = 0 , para = 1 }
	Values for orientation. More...

Construction
Parameters value Value to initialize bvalue boolean to initialize true == para ivalue integer to initialize 0 == anti, para everything else.
	Orientation () noexcept
	Test for equality of value.
	Orientation (Value value) noexcept
	Test for equality of value.
	Orientation (bool bvalue) noexcept
	Test for equality of value.
	Orientation (int ivalue) noexcept
	Test for equality of value.
void	Flip () noexcept
	Test for equality of value.
bool	operator== (Value value) const noexcept
	Test for equality of value.
bool	operator!= (Value value) const noexcept
	Test for inequality of value.
Value	operator! () const noexcept
	operator bool () const noexcept
	Test for equality of value.
	operator int () const noexcept
	Test for equality of value.
bool	operator== (const Orientation &a, const Orientation &b)
bool	operator!= (const Orientation &a, const Orientation &b)
bool	operator== (const Orientation::Value &a, const Orientation &b)
bool	operator!= (const Orientation::Value &a, const Orientation &b)

Detailed Description

Provides two values for orientation.

Member Enumeration Documentation

Value

enum class trax::Orientation::Value : char

strong

Values for orientation.

Enumerator
none	Denoting the unknown orientation.
anti	Denoting the non parallel or opposite orientation.
para	Denoting the aligned, parallel orientation.

Member Function Documentation

operator!()

Value trax::Orientation::operator! ( ) const

inlinenoexcept

Returns

true if anti and false if para.

Together with the Value constructor this lets turn an orientation O by O = !O.

Friends And Related Symbol Documentation

operator!= [1/2]

bool operator!= ( const Orientation & a, const Orientation & b )

friend

Returns

true if the two orientations are inequal, otherwise false.

operator!= [2/2]

bool operator!= ( const Orientation::Value & a, const Orientation & b )

friend

Returns

true if the two orientations are inequal, otherwise false.

operator== [1/2]

bool operator== ( const Orientation & a, const Orientation & b )

friend

Returns

true if the two orientations are equal, otherwise false.

operator== [2/2]

bool operator== ( const Orientation::Value & a, const Orientation & b )

friend

Returns

true if the two orientations are equal, otherwise false.

---

The documentation for this struct was generated from the following file:

• C:/Trend/Development/Trax3/Code/trax/Orientation.h