#include <yarp/math/Vec2D.h>

Inheritance diagram for yarp::math::Vec2D< T >:

Public Member Functions
	Vec2D ()

	Vec2D (const T &x_value, const T &y_value)

	Vec2D (const yarp::sig::Vector &v)

	operator yarp::sig::Vector () const

T	norm () const
	Returns the Euclidean norm of the Vec2D, i.e.

std::string	toString (int precision=-1, int width=-1) const
	Creates a string object containing a text representation of the object.

bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const override
	Write vector to a connection.

yarp::os::Type	getType () const override

yarp::math::Vec2D< T > &	operator+= (const yarp::math::Vec2D< T > &rhs)

yarp::math::Vec2D< T > &	operator-= (const yarp::math::Vec2D< T > &rhs)

bool	operator== (const yarp::math::Vec2D< T > &rhs) const

bool	operator!= (const yarp::math::Vec2D< T > &rhs) const

bool	read (yarp::os::ConnectionReader &connection)
	Read this object from a network connection.

bool	read (yarp::os::ConnectionReader &connection)
	Read this object from a network connection.

bool	read (yarp::os::ConnectionReader &connection)
	Read this object from a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const
	Write this object to a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const
	Write this object to a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const
	Write this object to a network connection.

bool	read (yarp::os::ConnectionReader &connection)
	Read this object from a network connection.

bool	read (yarp::os::ConnectionReader &connection)
	Read this object from a network connection.

bool	read (yarp::os::ConnectionReader &connection)
	Read this object from a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const
	Write this object to a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const
	Write this object to a network connection.

bool	write (yarp::os::ConnectionWriter &connection) const
	Write this object to a network connection.

Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.

virtual Type	getReadType () const

Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.

virtual void	onCompletion () const
	This is called when the port has finished all writing operations.

virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.

virtual yarp::os::Type	getWriteType () const

Public Attributes
T	x

T	y

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

template<typename T>
class yarp::math::Vec2D< T >

Definition at line 21 of file Vec2D.h.

Constructor & Destructor Documentation

◆ Vec2D() [1/3]

template<typename T >

yarp::math::Vec2D< T >::Vec2D ( )

Definition at line 184 of file Vec2D.cpp.

◆ Vec2D() [2/3]

template<typename T >

yarp::math::Vec2D< T >::Vec2D	(	const T &	x_value,
		const T &	y_value
	)

Definition at line 197 of file Vec2D.cpp.

◆ Vec2D() [3/3]

template<typename T >

yarp::math::Vec2D< T >::Vec2D ( const yarp::sig::Vector & v )

Definition at line 189 of file Vec2D.cpp.

Member Function Documentation

◆ getType()

template<typename T >

yarp::os::Type yarp::math::Vec2D< T >::getType ( ) const

inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 66 of file Vec2D.h.

◆ norm()

template<typename T >

T yarp::math::Vec2D< T >::norm ( ) const

Returns the Euclidean norm of the Vec2D, i.e.

sqrt(x^2+y^2)

Returns: the computed Euclidean norm.

Definition at line 177 of file Vec2D.cpp.

◆ operator yarp::sig::Vector()

template<typename T >

yarp::math::Vec2D< T >::operator yarp::sig::Vector ( ) const

inlineexplicit

Definition at line 33 of file Vec2D.h.

◆ operator!=()

template<typename T >

bool yarp::math::Vec2D< T >::operator!= ( const yarp::math::Vec2D< T > & rhs ) const

Definition at line 254 of file Vec2D.cpp.

◆ operator+=()

template<typename T >

yarp::math::Vec2D< T > & yarp::math::Vec2D< T >::operator+= ( const yarp::math::Vec2D< T > & rhs )

Definition at line 228 of file Vec2D.cpp.

◆ operator-=()

template<typename T >

yarp::math::Vec2D< T > & yarp::math::Vec2D< T >::operator-= ( const yarp::math::Vec2D< T > & rhs )

Definition at line 236 of file Vec2D.cpp.

◆ operator==()

template<typename T >

bool yarp::math::Vec2D< T >::operator== ( const yarp::math::Vec2D< T > & rhs ) const

Definition at line 244 of file Vec2D.cpp.

◆ read() [1/7]

bool yarp::math::Vec2D< double >::read ( yarp::os::ConnectionReader & reader )

virtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 38 of file Vec2D.cpp.

◆ read() [2/7]

bool yarp::math::Vec2D< int >::read ( yarp::os::ConnectionReader & reader )

virtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 62 of file Vec2D.cpp.

◆ read() [3/7]

bool yarp::math::Vec2D< size_t >::read ( yarp::os::ConnectionReader & reader )

virtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 86 of file Vec2D.cpp.

◆ read() [4/7]

bool yarp::math::Vec2D< double >::read ( yarp::os::ConnectionReader & reader )

virtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

◆ read() [5/7]

bool yarp::math::Vec2D< int >::read ( yarp::os::ConnectionReader & reader )

virtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

◆ read() [6/7]

bool yarp::math::Vec2D< size_t >::read ( yarp::os::ConnectionReader & reader )

virtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

◆ read() [7/7]

template<typename T >

bool yarp::math::Vec2D< T >::read ( yarp::os::ConnectionReader & reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader an interface to the network connection for reading

Returns: true iff the object is successfully read

Implements yarp::os::Portable.

◆ toString()

template<typename T >

std::string yarp::math::Vec2D< T >::toString	(	int	precision = `-1`,
		int	width = `-1`
	)		const

Creates a string object containing a text representation of the object.

Useful for printing.

Returns: the generated string

Definition at line 167 of file Vec2D.cpp.

◆ write() [1/7]

bool yarp::math::Vec2D< double >::write ( yarp::os::ConnectionWriter & writer ) const

virtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer an interface to the network connection for writing

Returns: true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 110 of file Vec2D.cpp.

◆ write() [2/7]

bool yarp::math::Vec2D< int >::write ( yarp::os::ConnectionWriter & writer ) const

virtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer an interface to the network connection for writing

Returns: true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 128 of file Vec2D.cpp.

◆ write() [3/7]

bool yarp::math::Vec2D< size_t >::write ( yarp::os::ConnectionWriter & writer ) const

virtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer an interface to the network connection for writing

Returns: true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 146 of file Vec2D.cpp.

◆ write() [4/7]

bool yarp::math::Vec2D< double >::write ( yarp::os::ConnectionWriter & writer ) const

virtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer an interface to the network connection for writing

Returns: true iff the object is successfully written

Implements yarp::os::Portable.

◆ write() [5/7]

bool yarp::math::Vec2D< int >::write ( yarp::os::ConnectionWriter & writer ) const

virtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer an interface to the network connection for writing

Returns: true iff the object is successfully written

Implements yarp::os::Portable.

◆ write() [6/7]

bool yarp::math::Vec2D< size_t >::write ( yarp::os::ConnectionWriter & writer ) const

virtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer an interface to the network connection for writing

Returns: true iff the object is successfully written

Implements yarp::os::Portable.

◆ write() [7/7]

template<typename T >

bool yarp::math::Vec2D< T >::write ( yarp::os::ConnectionWriter & connection ) const

overridevirtual

Write vector to a connection.

return true if a Vec2D was written correctly

Implements yarp::os::Portable.

Member Data Documentation

◆ x

template<typename T >

T yarp::math::Vec2D< T >::x

Definition at line 27 of file Vec2D.h.

◆ y

template<typename T >

T yarp::math::Vec2D< T >::y

Definition at line 28 of file Vec2D.h.

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

src/libYARP_math/src/yarp/math/Vec2D.h
src/libYARP_math/src/yarp/math/Vec2D.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Vec2D() [1/3]

◆ Vec2D() [2/3]

◆ Vec2D() [3/3]

Member Function Documentation

◆ getType()

◆ norm()

◆ operator yarp::sig::Vector()

◆ operator!=()

◆ operator+=()

◆ operator-=()

◆ operator==()

◆ read() [1/7]

◆ read() [2/7]

◆ read() [3/7]

◆ read() [4/7]

◆ read() [5/7]

◆ read() [6/7]

◆ read() [7/7]

◆ toString()

◆ write() [1/7]

◆ write() [2/7]

◆ write() [3/7]

◆ write() [4/7]

◆ write() [5/7]

◆ write() [6/7]

◆ write() [7/7]

Member Data Documentation

◆ x

◆ y