bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData > Class Template Reference

class LineSegmentLink. Represents a straight line link between two waypoints. More...

#include <line_segment_link.h>

Inheritance diagram for bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >:

Collaboration diagram for bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >:

Public Types
typedef NodeData	node_data_type
typedef SegmentData	segment_data_type
typedef WayPoint< dim, NodeData >	w_point_type

Public Member Functions
	LineSegmentLink ()
	Default ctor.
	LineSegmentLink (const w_point_type &v1, const w_point_type &v2, uint_t id, const segment_data_type &data)
	Constructor.
	LineSegmentLink (const w_point_type &v1, const w_point_type &v2, uint_t id)
	Constructor.
bool	is_active () const
	Returns true if the segment is active.
void	deactivate ()
	deactive the segment
void	make_active ()
	Activate the segment.

Static Public Attributes
static const int	dimension = dim

Detailed Description

template<int dim, typename NodeData, typename SegmentData>
class bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >

class LineSegmentLink. Represents a straight line link between two waypoints.

Member Typedef Documentation

node_data_type

template<int dim, typename NodeData , typename SegmentData >

typedef NodeData bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::node_data_type

segment_data_type

template<int dim, typename NodeData , typename SegmentData >

typedef SegmentData bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::segment_data_type

w_point_type

template<int dim, typename NodeData , typename SegmentData >

typedef WayPoint<dim, NodeData> bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::w_point_type

Constructor & Destructor Documentation

LineSegmentLink() [1/3]

template<int dim, typename NodeData , typename SegmentData >

bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::LineSegmentLink

(

)

Default ctor.

LineSegmentLink() [2/3]

template<int dim, typename NodeData , typename SegmentData >

bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::LineSegmentLink	(	const w_point_type &	v1,
		const w_point_type &	v2,
		uint_t	id,
		const segment_data_type &	data
	)

Constructor.

LineSegmentLink() [3/3]

template<int dim, typename NodeData , typename SegmentData >

bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::LineSegmentLink	(	const w_point_type &	v1,
		const w_point_type &	v2,
		uint_t	id
	)

Constructor.

Member Function Documentation

deactivate()

template<int dim, typename NodeData , typename SegmentData >

void bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::deactivate ( )

inline

deactive the segment

is_active()

template<int dim, typename NodeData , typename SegmentData >

bool bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::is_active ( ) const

inline

Returns true if the segment is active.

make_active()

template<int dim, typename NodeData , typename SegmentData >

void bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::make_active ( )

inline

Activate the segment.

Member Data Documentation

dimension

template<int dim, typename NodeData , typename SegmentData >

const int bitrl::utils::trajectory::LineSegmentLink< dim, NodeData, SegmentData >::dimension = dim

static

---

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

• libs/bitrl/src/bitrl/utils/trajectory/line_segment_link.h