vtkArrayRange Class Reference

#include <vtkArrayRange.h>

List of all members.


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 (tshead@sandia.gov) at Sandia National Laboratories.
Examples:
vtkArrayRange (Examples)
Tests:
vtkArrayRange (Tests)

Definition at line 47 of file vtkArrayRange.h.


Public Member Functions

 vtkArrayRange ()
 vtkArrayRange (vtkIdType begin, vtkIdType end)
vtkIdType GetBegin () const
vtkIdType GetEnd () const
vtkIdType GetSize () const
bool Contains (const vtkArrayRange &range) const
bool Contains (const vtkIdType coordinate) const

Friends

VTK_COMMON_EXPORT friend ostream & operator<< (ostream &stream, const vtkArrayRange &rhs)
VTK_COMMON_EXPORT friend bool operator== (const vtkArrayRange &lhs, const vtkArrayRange &rhs)
VTK_COMMON_EXPORT friend bool operator!= (const vtkArrayRange &lhs, const vtkArrayRange &rhs)

Constructor & Destructor Documentation

vtkArrayRange::vtkArrayRange (  ) 

Creates an empty range.

vtkArrayRange::vtkArrayRange ( vtkIdType  begin,
vtkIdType  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

vtkIdType vtkArrayRange::GetBegin (  )  const

Returns the beginning of the range

vtkIdType vtkArrayRange::GetEnd (  )  const

Returns one-past-the-end of the range

vtkIdType 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 vtkIdType  coordinate  )  const

Returns true iff the given coordinate falls within this range.


Friends And Related Function Documentation

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

Equality comparisons.

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

Equality comparisons.

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

Serialization.


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

Generated on Mon Sep 27 18:18:02 2010 for VTK by  doxygen 1.5.6