Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem > Class Template Reference

2D point in Cartesian coordinate system More...

#include <point_xy.hpp>

Inheritance diagram for boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >:
Collaboration diagram for boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >:

Public Member Functions

 point_xy ()
 Default constructor, does not initialize anything. More...
 
 point_xy (CoordinateType const &x, CoordinateType const &y)
 Constructor with x/y values. More...
 
CoordinateType const & x () const
 Get x-value. More...
 
CoordinateType const & y () const
 Get y-value. More...
 
void x (CoordinateType const &v)
 Set x-value. More...
 
void y (CoordinateType const &v)
 Set y-value. More...
 
CoordinateType const & get () const
 Get a coordinate. More...
 
void set (CoordinateType const &value)
 Set a coordinate. More...
 

Detailed Description

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
class boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >

2D point in Cartesian coordinate system

Template Parameters
CoordinateTypenumeric type, for example, double, float, int
CoordinateSystemcoordinate system, defaults to cs::cartesian

{before.synopsis, [heading Model of] [link geometry.reference.concepts.concept_point Point Concept] }

{[include reference/geometries/point_assign_warning.qbk]}

Constructor & Destructor Documentation

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >::point_xy ( )
inline

Default constructor, does not initialize anything.

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >::point_xy ( CoordinateType const &  x,
CoordinateType const &  y 
)
inline

Constructor with x/y values.

Member Function Documentation

CoordinateType const& boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >::get ( ) const
inlineinherited

Get a coordinate.

Template Parameters
Kcoordinate to get
Returns
the coordinate

References boost::BOOST_STATIC_ASSERT().

void boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >::set ( CoordinateType const &  value)
inlineinherited

Set a coordinate.

Template Parameters
Kcoordinate to set
Parameters
valuevalue to set

References boost::BOOST_STATIC_ASSERT(), and boost::program_options::value().

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
CoordinateType const& boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >::x ( ) const
inline

Get x-value.

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
void boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >::x ( CoordinateType const &  v)
inline

Set x-value.

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
CoordinateType const& boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >::y ( ) const
inline

Get y-value.

template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
void boost::geometry::model::d2::point_xy< CoordinateType, CoordinateSystem >::y ( CoordinateType const &  v)
inline

Set y-value.


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