OpenMesh::BaseHandle Class Reference

Base class for all handle types. More...

#include <Handles.hh>

Inheritance diagram for OpenMesh::BaseHandle:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void __decrement ()
void __increment ()
 BaseHandle (int _idx=-1)
int idx () const
 Get the underlying index of this handle.
void invalidate ()
 reset handle to be invalid
bool is_valid () const
 The handle is valid iff the index is not equal to -1.
bool operator!= (const BaseHandle &_rhs) const
bool operator< (const BaseHandle &_rhs) const
bool operator== (const BaseHandle &_rhs) const
void reset ()
 reset handle to be invalid

Private Attributes

int idx_

Detailed Description

Base class for all handle types.

Definition at line 60 of file Handles.hh.


Constructor & Destructor Documentation

OpenMesh::BaseHandle::BaseHandle ( int  _idx = -1  )  [inline, explicit]

Definition at line 64 of file Handles.hh.


Member Function Documentation

void OpenMesh::BaseHandle::__decrement (  )  [inline]

Definition at line 92 of file Handles.hh.

void OpenMesh::BaseHandle::__increment (  )  [inline]

Definition at line 91 of file Handles.hh.

int OpenMesh::BaseHandle::idx (  )  const [inline]

Get the underlying index of this handle.

Definition at line 67 of file Handles.hh.

void OpenMesh::BaseHandle::invalidate (  )  [inline]

reset handle to be invalid

Definition at line 75 of file Handles.hh.

bool OpenMesh::BaseHandle::is_valid ( void   )  const [inline]

The handle is valid iff the index is not equal to -1.

Definition at line 70 of file Handles.hh.

bool OpenMesh::BaseHandle::operator!= ( const BaseHandle _rhs  )  const [inline]

Definition at line 81 of file Handles.hh.

bool OpenMesh::BaseHandle::operator< ( const BaseHandle _rhs  )  const [inline]

Definition at line 85 of file Handles.hh.

bool OpenMesh::BaseHandle::operator== ( const BaseHandle _rhs  )  const [inline]

Definition at line 77 of file Handles.hh.

void OpenMesh::BaseHandle::reset (  )  [inline]

reset handle to be invalid

Definition at line 73 of file Handles.hh.


Member Data Documentation

Definition at line 97 of file Handles.hh.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


openmesh
Author(s): Benjamin Pitzer
autogenerated on Fri Jan 11 12:11:16 2013