vtkArrayRange Class Reference

Stores a half-open range of array coordinates. More...

#include <vtkArrayRange.h>

List of all members.

Public Types
typedef vtkArrayCoordinates::CoordinateT	CoordinateT
Public Member Functions
	vtkArrayRange ()
	vtkArrayRange (CoordinateT begin, CoordinateT end)
CoordinateT	GetBegin () const
CoordinateT	GetEnd () const
CoordinateT	GetSize () const
bool	Contains (const vtkArrayRange &range) const
bool	Contains (const CoordinateT coordinate) const
Friends
VTKCOMMONCORE_EXPORT friend ostream &	operator<< (ostream &stream, const vtkArrayRange &rhs)
VTKCOMMONCORE_EXPORT friend bool	operator== (const vtkArrayRange &lhs, const vtkArrayRange &rhs)
VTKCOMMONCORE_EXPORT friend bool	operator!= (const vtkArrayRange &lhs, const vtkArrayRange &rhs)

---

Detailed Description

Stores a half-open range of array coordinates.

vtkArrayRange stores a half-open range of array coordinates along a single dimension of a vtkArraySlice object.

See also:

vtkArray, vtkArrayRange

Thanks:

Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Examples:

vtkArrayRange (Examples)

Tests:

vtkArrayRange (Tests)

Definition at line 50 of file vtkArrayRange.h.

---

Member Typedef Documentation

typedef vtkArrayCoordinates::CoordinateT vtkArrayRange::CoordinateT

Definition at line 53 of file vtkArrayRange.h.

---

Constructor & Destructor Documentation

vtkArrayRange::vtkArrayRange

(

)

Creates an empty range.

vtkArrayRange::vtkArrayRange	(	CoordinateT	begin,
		CoordinateT	end
	)

Creates a half-open range [begin, end). Note that begin must be <= end, if not, creates the empty range [begin, begin).

---

Member Function Documentation

CoordinateT vtkArrayRange::GetBegin

(

)

const

Returns the beginning of the range

CoordinateT vtkArrayRange::GetEnd

(

)

const

Returns one-past-the-end of the range

CoordinateT vtkArrayRange::GetSize

(

)

const

Returns the size of the range (the distance End - Begin).

bool vtkArrayRange::Contains

(

const vtkArrayRange &

range

)

const

Returns true iff the given range is a non-overlapping subset of this range.

bool vtkArrayRange::Contains

(

const CoordinateT

coordinate

)

const

Returns true iff the given coordinate falls within this range.

---

Friends And Related Function Documentation

VTKCOMMONCORE_EXPORT friend bool operator==	(	const vtkArrayRange &	lhs,
		const vtkArrayRange &	rhs
	)		[friend]

Equality comparisons.

VTKCOMMONCORE_EXPORT friend bool operator!=	(	const vtkArrayRange &	lhs,
		const vtkArrayRange &	rhs
	)		[friend]

Equality comparisons.

VTKCOMMONCORE_EXPORT friend ostream& operator<<	(	ostream &	stream,
		const vtkArrayRange &	rhs
	)		[friend]

Serialization.

---

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

• dox/Common/Core/vtkArrayRange.h