MeVisLab Toolbox Reference
ml::WEMPrimitive Class Reference

This is the base class for the WEM elements nodes, edges, and faces. More...

#include <WEMPrimitive.h>

Inheritance diagram for ml::WEMPrimitive:
ml::WEMEdge ml::WEMFace ml::WEMNode ml::WEMPolygon ml::WEMQuad ml::WEMTriangle

Public Member Functions

 WEMPrimitive ()
 WEMPrimitive (const WEMPrimitive &)=default
 WEMPrimitive (WEMPrimitive &&p) noexcept
WEMPrimitive & operator= (const WEMPrimitive &)=default
WEMPrimitive & operator= (WEMPrimitive &&p) noexcept
virtual ~WEMPrimitive ()=default
 Standard destructor.
void resetPrimitive ()
 Resets the object to its default constructed state.
int getEntryNumber () const
void setEntryNumber (int e)
 Sets the entry number.
bool isSet (unsigned int bit) const
 Returns whether the bit-flag is set.
void setFlag (unsigned int bit)
 Sets the given bit-flag.
void unsetFlag (unsigned int bit)
 Unsets the given bit-flag.
void clearFlag ()
 Clears the bit-flag.
bool isTraversed () const
 Returns whether this primitive has been traversed.
void setTraversed (bool traversed)
 Sets the traversed flag.
int getHeapPosition () const
 Returns the heap position.
bool inHeap () const
 Returns whether this primitive is in the heap.
void setHeapPosition (int heapPosition)
 Sets the heap position.
double getHeapValue () const
 Returns the heap value.
void setHeapValue (double heapValue)
 Sets the heap value.

Protected Attributes

unsigned int _bitFlag
 Bit-wise flag for custom use.
int _entryNumber
 Entry number in index vector, for easy deletion and reference.
int _heapPosition
 Heap position, same like entryNumber but for heaps.
double _heapValue
 Element value, used for heap sorting.

Detailed Description

This is the base class for the WEM elements nodes, edges, and faces.

Definition at line 27 of file WEMPrimitive.h.

Constructor & Destructor Documentation

◆ WEMPrimitive() [1/3]

ml::WEMPrimitive::WEMPrimitive ( )

Referenced by operator=(), operator=(), WEMPrimitive(), and WEMPrimitive().

◆ WEMPrimitive() [2/3]

ml::WEMPrimitive::WEMPrimitive ( const WEMPrimitive & )
default

References WEMPrimitive().

◆ WEMPrimitive() [3/3]

ml::WEMPrimitive::WEMPrimitive ( WEMPrimitive && p)
noexcept

References WEMPrimitive().

◆ ~WEMPrimitive()

virtual ml::WEMPrimitive::~WEMPrimitive ( )
virtualdefault

Standard destructor.

Member Function Documentation

◆ clearFlag()

void ml::WEMPrimitive::clearFlag ( )
inline

Clears the bit-flag.

Definition at line 52 of file WEMPrimitive.h.

References _bitFlag.

◆ getEntryNumber()

int ml::WEMPrimitive::getEntryNumber ( ) const
inline

Returns the entry number. The entryNumber is the index into the (vector-like) structure the primitive is stored in internally.

Definition at line 42 of file WEMPrimitive.h.

References _entryNumber.

◆ getHeapPosition()

int ml::WEMPrimitive::getHeapPosition ( ) const
inline

Returns the heap position.

Definition at line 58 of file WEMPrimitive.h.

References _heapPosition.

Referenced by ml::WEMContainer< T >::append(), ml::WEMHeap< T >::insert(), ml::WEMHeap< T >::insert(), ml::WEMContainer< T >::remove(), ml::WEMHeap< T >::remove(), and ml::WEMHeap< T >::update().

◆ getHeapValue()

double ml::WEMPrimitive::getHeapValue ( ) const
inline

Returns the heap value.

Definition at line 64 of file WEMPrimitive.h.

References _heapValue.

Referenced by ml::WEMHeap< T >::update().

◆ inHeap()

bool ml::WEMPrimitive::inHeap ( ) const
inline

Returns whether this primitive is in the heap.

Definition at line 60 of file WEMPrimitive.h.

References _heapPosition.

◆ isSet()

bool ml::WEMPrimitive::isSet ( unsigned int bit) const
inline

Returns whether the bit-flag is set.

Definition at line 46 of file WEMPrimitive.h.

References _bitFlag.

◆ isTraversed()

bool ml::WEMPrimitive::isTraversed ( ) const
inline

Returns whether this primitive has been traversed.

Definition at line 54 of file WEMPrimitive.h.

References _bitFlag, and WEM_TRAVERSED_BIT.

◆ operator=() [1/2]

WEMPrimitive & ml::WEMPrimitive::operator= ( const WEMPrimitive & )
default

References WEMPrimitive().

◆ operator=() [2/2]

WEMPrimitive & ml::WEMPrimitive::operator= ( WEMPrimitive && p)
noexcept

References WEMPrimitive().

◆ resetPrimitive()

void ml::WEMPrimitive::resetPrimitive ( )

Resets the object to its default constructed state.

◆ setEntryNumber()

void ml::WEMPrimitive::setEntryNumber ( int e)
inline

Sets the entry number.

Definition at line 44 of file WEMPrimitive.h.

References _entryNumber.

◆ setFlag()

void ml::WEMPrimitive::setFlag ( unsigned int bit)
inline

Sets the given bit-flag.

Definition at line 48 of file WEMPrimitive.h.

References _bitFlag.

◆ setHeapPosition()

void ml::WEMPrimitive::setHeapPosition ( int heapPosition)
inline

Sets the heap position.

Definition at line 62 of file WEMPrimitive.h.

References _heapPosition.

Referenced by ml::WEMHeap< T >::remove(), and ml::WEMContainer< T >::replace().

◆ setHeapValue()

void ml::WEMPrimitive::setHeapValue ( double heapValue)
inline

Sets the heap value.

Definition at line 66 of file WEMPrimitive.h.

References _heapValue.

Referenced by ml::WEMHeap< T >::insert(), and ml::WEMHeap< T >::update().

◆ setTraversed()

void ml::WEMPrimitive::setTraversed ( bool traversed)

Sets the traversed flag.

◆ unsetFlag()

void ml::WEMPrimitive::unsetFlag ( unsigned int bit)
inline

Unsets the given bit-flag.

Definition at line 50 of file WEMPrimitive.h.

References _bitFlag.

Member Data Documentation

◆ _bitFlag

unsigned int ml::WEMPrimitive::_bitFlag
protected

Bit-wise flag for custom use.

Definition at line 71 of file WEMPrimitive.h.

Referenced by clearFlag(), isSet(), isTraversed(), setFlag(), and unsetFlag().

◆ _entryNumber

int ml::WEMPrimitive::_entryNumber
protected

Entry number in index vector, for easy deletion and reference.

Definition at line 73 of file WEMPrimitive.h.

Referenced by getEntryNumber(), and setEntryNumber().

◆ _heapPosition

int ml::WEMPrimitive::_heapPosition
protected

Heap position, same like entryNumber but for heaps.

Definition at line 75 of file WEMPrimitive.h.

Referenced by getHeapPosition(), inHeap(), and setHeapPosition().

◆ _heapValue

double ml::WEMPrimitive::_heapValue
protected

Element value, used for heap sorting.

Definition at line 77 of file WEMPrimitive.h.

Referenced by getHeapValue(), and setHeapValue().

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