This class defines an twodimensional IndexPoint, i.e. a pair of unsigned integers representing a value in a twodimensional index space.
More...
#include <Index.h>
This class defines an twodimensional IndexPoint, i.e. a pair of unsigned integers representing a value in a twodimensional index space.
Definition at line 128 of file Index.h.
skelcl::IndexPoint::IndexPoint 
( 
const IndexPoint & 
rhs  ) 


default 
Default copy constructor.
 Parameters

skelcl::IndexPoint::IndexPoint 
( 
const Index & 
row, 


const Index & 
column 

) 
 
Creates an IndexPoint with the given values so that the IndexPoint {row,column} is created.
 Parameters

row  The value is used as first value of the pair. 
column  The value is used as second value of the pair. 
Definition at line 84 of file Index.cpp.
skelcl::IndexPoint::IndexPoint 
( 
IndexPoint && 
indexPoint  ) 

const Index & skelcl::IndexPoint::columnID 
( 
 ) 
const 
Function to access the second component of the underlying pair of unsigned integers representing this IndexPoint object.
 Returns
 The second component of the pair of unsigned integers representing this IndexPoint object.
Definition at line 133 of file Index.cpp.
Explicit function to access the underlying pair of unsigned integer representing this IndexPoint object.
 Returns
 The pair of unsigned integer representing this IndexPoint object.
Definition at line 118 of file Index.cpp.
Conversion operator. The IndexPoint object is automatically converted in the underlying pair of unsigned integer representing this IndexPoint object.
 Returns
 The pair of unsigned integer representing this IndexPoint object.
Definition at line 113 of file Index.cpp.
bool skelcl::IndexPoint::operator!= 
( 
const IndexPoint & 
rhs  ) 
const 
Inequality operator. Two IndexPoint objects are not equal if and only if the two underlying pairs of unsigned integer are not equal.
 Parameters

 Returns
 True if and only if the two underlying pairs of unsigned integers are not equal. False otherwise.
Definition at line 108 of file Index.cpp.
Move assignment operator. Assign IndexPoint rhs to this.
 Parameters

rhs  The IndexPoint which values are assigned to this. 
Definition at line 95 of file Index.cpp.
Copy assignment operator. Assign rhs to this.
 Parameters

rhs  The IndexPoint which values are assigned to this. 
bool skelcl::IndexPoint::operator== 
( 
const IndexPoint & 
rhs  ) 
const 
Equality operator. Two IndexPoint objects are equal if and only if the two underlying pairs of unsigned integer are equal.
 Parameters

 Returns
 True if and only if the two underlying pairs of unsigned integers are equal (i.e. both components are equal). False otherwise.
Definition at line 103 of file Index.cpp.
const Index & skelcl::IndexPoint::rowID 
( 
 ) 
const 
Function to access the first component of the underlying pair of unsigned integers representing this IndexPoint object.
 Returns
 The first component of the pair of unsigned integers representing this IndexPoint object.
Definition at line 123 of file Index.cpp.
const Index & skelcl::IndexPoint::x 
( 
 ) 
const 
Function to access the second component of the underlying pair of unsigned integers representing this IndexPoint object.
 Returns
 The second component of the pair of unsigned integers representing this IndexPoint object.
Definition at line 138 of file Index.cpp.
const Index & skelcl::IndexPoint::y 
( 
 ) 
const 
Function to access the first component of the underlying pair of unsigned integers representing this IndexPoint object.
 Returns
 The first component of the pair of unsigned integers representing this IndexPoint object.
Definition at line 128 of file Index.cpp.
The documentation for this class was generated from the following files: