scifir::coordinates_2d< T > Class Template Reference

#include <coordinates_2d.hpp>

Public Types
enum	type { CARTESIAN , POLAR }

Public Member Functions
	coordinates_2d ()
	coordinates_2d (const coordinates_2d< T > &x_coordinates)
	coordinates_2d (coordinates_2d< T > &&x_coordinates)
	coordinates_2d (const scalar_unit &new_x, const scalar_unit &new_y)
	coordinates_2d (const scalar_unit &new_p, const angle &new_theta)
	coordinates_2d (coordinates_2d::type coordinates_type, const string &coord1, const string &coord2)
	coordinates_2d (const string &init_coordinates_2d)
coordinates_2d< T > &	operator= (const coordinates_2d< T > &x_coordinates)
coordinates_2d< T > &	operator= (coordinates_2d< T > &&x_coordinates)
coordinates_2d< T > &	operator= (const string &init_coordinates_2d)
T	get_p () const
angle	get_theta () const
void	set_position (const scalar_unit &new_x, const scalar_unit &new_y)
void	set_position (const scalar_unit &new_p, const angle &new_theta)
void	rotate (const angle &x_angle)
void	move (const displacement_2d &x_displacement)
void	move (const scalar_unit &new_x, const scalar_unit &new_y)
void	move (const scalar_unit &new_p, const angle &new_theta)
T	distance_to_origin () const
string	display_cartesian () const
string	display_polar () const

Static Public Member Functions
static coordinates_2d< T >	origin (const coordinates_2d< T > &origin, const coordinates_2d< T > &coordinates)

Public Attributes
T	x
T	y

Private Member Functions
void	initialize_from_string (string init_coordinates_2d)

Detailed Description

template<typename T = length>
class scifir::coordinates_2d< T >

Definition at line 16 of file coordinates_2d.hpp.

Member Enumeration Documentation

type

template<typename T = length>

enum scifir::coordinates_2d::type

Enumerator
CARTESIAN
POLAR

Definition at line 19 of file coordinates_2d.hpp.

{ CARTESIAN, POLAR };

Constructor & Destructor Documentation

coordinates_2d() [1/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( )

inline

Definition at line 21 of file coordinates_2d.hpp.

                             : x(),y()
            {}

coordinates_2d() [2/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( const coordinates_2d< T > &  x_coordinates )

inline

Definition at line 24 of file coordinates_2d.hpp.

                                                                   : x(x_coordinates.x),y(x_coordinates.y)
            {}

coordinates_2d() [3/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( coordinates_2d< T > &&  x_coordinates )

inline

Definition at line 27 of file coordinates_2d.hpp.

                                                              : x(std::move(x_coordinates.x)),y(std::move(x_coordinates.y))
            {}

coordinates_2d() [4/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( const scalar_unit &  new_x, const scalar_unit &  new_y  )

inlineexplicit

Definition at line 30 of file coordinates_2d.hpp.

                                                                                       : x(new_x),y(new_y)
            {}

coordinates_2d() [5/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( const scalar_unit &  new_p, const angle &  new_theta  )

inlineexplicit

Definition at line 33 of file coordinates_2d.hpp.

                                                                                     : coordinates_2d()
            {
                set_position(new_p,new_theta);
            }

coordinates_2d() [6/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( coordinates_2d< T >::type  coordinates_type, const string &  coord1, const string &  coord2  )

inlineexplicit

Definition at line 38 of file coordinates_2d.hpp.

                                                                                                                     : coordinates_2d()
            {
                if (coordinates_type == coordinates_2d<length>::CARTESIAN)
                {
                    set_position(T(coord1),T(coord2));
                }
                else if (coordinates_type == coordinates_2d<length>::POLAR)
                {
                    set_position(T(coord1),angle(coord2));
                }
            }

coordinates_2d() [7/7]

template<typename T = length>

scifir::coordinates_2d< T >::coordinates_2d ( const string &  init_coordinates_2d )

inlineexplicit

Definition at line 50 of file coordinates_2d.hpp.

                                                                       : coordinates_2d()
            {
                initialize_from_string(init_coordinates_2d);
            }

Member Function Documentation

display_cartesian()

template<typename T = length>

string scifir::coordinates_2d< T >::display_cartesian ( ) const

inline

Definition at line 135 of file coordinates_2d.hpp.

            {
                ostringstream out;
                out << "(" << x << "," << y << ")";
                return out.str();
            }

display_polar()

template<typename T = length>

string scifir::coordinates_2d< T >::display_polar ( ) const

inline

Definition at line 142 of file coordinates_2d.hpp.

            {
                ostringstream out;
                out << "(" << get_p() << "," << get_theta() << ")";
                return out.str();
            }

distance_to_origin()

template<typename T = length>

T scifir::coordinates_2d< T >::distance_to_origin ( ) const

inline

Definition at line 130 of file coordinates_2d.hpp.

            {
                return T(scifir::sqrt(scifir::pow(x,2) + scifir::pow(y,2)));
            }

get_p()

template<typename T = length>

T scifir::coordinates_2d< T >::get_p ( ) const

inline

Definition at line 82 of file coordinates_2d.hpp.

            {
                return T(scifir::sqrt(scifir::pow(x,2) + scifir::pow(y,2)));
            }

get_theta()

template<typename T = length>

angle scifir::coordinates_2d< T >::get_theta ( ) const

inline

Definition at line 87 of file coordinates_2d.hpp.

            {
                return scifir::atan2(y.get_value(),x.get_value());
            }

initialize_from_string()

template<typename T = length>

void scifir::coordinates_2d< T >::initialize_from_string ( string  init_coordinates_2d )

inlineprivate

Definition at line 153 of file coordinates_2d.hpp.

            {
                vector<string> values;
                if (init_coordinates_2d.front() == '(')
                {
                    init_coordinates_2d.erase(0,1);
                }
                if (init_coordinates_2d.back() == ')')
                {
                    init_coordinates_2d.erase(init_coordinates_2d.size()-1,1);
                }
                boost::split(values,init_coordinates_2d,boost::is_any_of(","));
                if (values.size() == 2)
                {
                    if (is_angle(values[1]))
                    {
                        set_position(T(values[0]),angle(values[1]));
                    }
                    else
                    {
                        set_position(T(values[0]),T(values[1]));
                    }
                }
            }

move() [1/3]

template<typename T = length>

void scifir::coordinates_2d< T >::move ( const displacement_2d &  x_displacement )

inline

Definition at line 112 of file coordinates_2d.hpp.

            {
                x += x_displacement.x_projection();
                y += x_displacement.y_projection();
            }

move() [2/3]

template<typename T = length>

void scifir::coordinates_2d< T >::move ( const scalar_unit &  new_p, const angle &  new_theta  )

inline

Definition at line 124 of file coordinates_2d.hpp.

            {
                x += new_p * scifir::cos(new_theta);
                y += new_p * scifir::sin(new_theta);
            }

move() [3/3]

template<typename T = length>

void scifir::coordinates_2d< T >::move ( const scalar_unit &  new_x, const scalar_unit &  new_y  )

inline

Definition at line 118 of file coordinates_2d.hpp.

            {
                x += new_x;
                y += new_y;
            }

operator=() [1/3]

template<typename T = length>

coordinates_2d< T > & scifir::coordinates_2d< T >::operator= ( const coordinates_2d< T > &  x_coordinates )

inline

Definition at line 55 of file coordinates_2d.hpp.

            {
                x = x_coordinates.x;
                y = x_coordinates.y;
                return *this;
            }

operator=() [2/3]

template<typename T = length>

coordinates_2d< T > & scifir::coordinates_2d< T >::operator= ( const string &  init_coordinates_2d )

inline

Definition at line 69 of file coordinates_2d.hpp.

            {
                initialize_from_string(init_coordinates_2d);
                return *this;
            }

operator=() [3/3]

template<typename T = length>

coordinates_2d< T > & scifir::coordinates_2d< T >::operator= ( coordinates_2d< T > &&  x_coordinates )

inline

Definition at line 62 of file coordinates_2d.hpp.

            {
                x = std::move(x_coordinates.x);
                y = std::move(x_coordinates.y);
                return *this;
            }

origin()

template<typename T = length>

static coordinates_2d< T > scifir::coordinates_2d< T >::origin ( const coordinates_2d< T > &  origin, const coordinates_2d< T > &  coordinates  )

inlinestatic

Definition at line 75 of file coordinates_2d.hpp.

            {
                coordinates_2d<T> new_coordinates(origin);
                new_coordinates.move(coordinates.x,coordinates.y);
                return new_coordinates;
            }

rotate()

template<typename T = length>

void scifir::coordinates_2d< T >::rotate ( const angle &  x_angle )

inline

Definition at line 104 of file coordinates_2d.hpp.

            {
                T x_coord = x;
                T y_coord = y;
                x = x_coord * scifir::cos(x_angle) - y_coord * scifir::sin(x_angle);
                y = x_coord * scifir::sin(x_angle) + y_coord * scifir::cos(x_angle);
            }

set_position() [1/2]

template<typename T = length>

void scifir::coordinates_2d< T >::set_position ( const scalar_unit &  new_p, const angle &  new_theta  )

inline

Definition at line 98 of file coordinates_2d.hpp.

            {
                x = T(new_p * scifir::cos(new_theta));
                y = T(new_p * scifir::sin(new_theta));
            }

set_position() [2/2]

template<typename T = length>

void scifir::coordinates_2d< T >::set_position ( const scalar_unit &  new_x, const scalar_unit &  new_y  )

inline

Definition at line 92 of file coordinates_2d.hpp.

            {
                x = new_x;
                y = new_y;
            }

Member Data Documentation

x

template<typename T = length>

T scifir::coordinates_2d< T >::x

Definition at line 149 of file coordinates_2d.hpp.

y

template<typename T = length>

T scifir::coordinates_2d< T >::y

Definition at line 150 of file coordinates_2d.hpp.

---

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

• coordinates/coordinates_2d.hpp