Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
karto::Size2< T > Class Template Reference

#include <Karto.h>

Public Member Functions

const T GetHeight () const
 
const T GetWidth () const
 
kt_bool operator!= (const Size2 &rOther) const
 
Size2operator= (const Size2 &rOther)
 
kt_bool operator== (const Size2 &rOther) const
 
void SetHeight (T height)
 
void SetWidth (T width)
 
 Size2 ()
 
 Size2 (T width, T height)
 
 Size2 (const Size2 &rOther)
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

m_Height
 
m_Width
 

Friends

class boost::serialization::access
 
std::ostream & operator<< (std::ostream &rStream, const Size2 &rSize)
 

Detailed Description

template<typename T>
class karto::Size2< T >

Represents a size (width, height) in 2-dimensional real space.

Definition at line 870 of file Karto.h.

Constructor & Destructor Documentation

◆ Size2() [1/3]

template<typename T>
karto::Size2< T >::Size2 ( )
inline

Default constructor

Definition at line 876 of file Karto.h.

◆ Size2() [2/3]

template<typename T>
karto::Size2< T >::Size2 ( width,
height 
)
inline

Constructor initializing point location

Parameters
width
height

Definition at line 887 of file Karto.h.

◆ Size2() [3/3]

template<typename T>
karto::Size2< T >::Size2 ( const Size2< T > &  rOther)
inline

Copy constructor

Parameters
rOther

Definition at line 897 of file Karto.h.

Member Function Documentation

◆ GetHeight()

template<typename T>
const T karto::Size2< T >::GetHeight ( ) const
inline

Gets the height

Returns
the height

Definition at line 926 of file Karto.h.

◆ GetWidth()

template<typename T>
const T karto::Size2< T >::GetWidth ( ) const
inline

Gets the width

Returns
the width

Definition at line 908 of file Karto.h.

◆ operator!=()

template<typename T>
kt_bool karto::Size2< T >::operator!= ( const Size2< T > &  rOther) const
inline

Inequality operator

Definition at line 962 of file Karto.h.

◆ operator=()

template<typename T>
Size2& karto::Size2< T >::operator= ( const Size2< T > &  rOther)
inline

Assignment operator

Definition at line 943 of file Karto.h.

◆ operator==()

template<typename T>
kt_bool karto::Size2< T >::operator== ( const Size2< T > &  rOther) const
inline

Equality operator

Definition at line 954 of file Karto.h.

◆ serialize()

template<typename T>
template<class Archive >
void karto::Size2< T >::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprivate

Definition at line 983 of file Karto.h.

◆ SetHeight()

template<typename T>
void karto::Size2< T >::SetHeight ( height)
inline

Sets the height

Parameters
height

Definition at line 935 of file Karto.h.

◆ SetWidth()

template<typename T>
void karto::Size2< T >::SetWidth ( width)
inline

Sets the width

Parameters
width

Definition at line 917 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

template<typename T>
friend class boost::serialization::access
friend

Definition at line 981 of file Karto.h.

◆ operator<<

template<typename T>
std::ostream& operator<< ( std::ostream &  rStream,
const Size2< T > &  rSize 
)
friend

Write Size2 onto output stream

Parameters
rStreamoutput stream
rSizeto write

Definition at line 972 of file Karto.h.

Member Data Documentation

◆ m_Height

template<typename T>
T karto::Size2< T >::m_Height
private

Definition at line 980 of file Karto.h.

◆ m_Width

template<typename T>
T karto::Size2< T >::m_Width
private

Definition at line 979 of file Karto.h.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Sat Oct 3 2020 03:51:02