ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier > Class Template Reference

#include <itkPriorityQueueContainer.h>

+ Inheritance diagram for itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >:
+ Collaboration diagram for itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >:

Detailed Description

template<typename TElementWrapper, typename TElementWrapperInterface, typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
class itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >

Definition at line 210 of file itkPriorityQueueContainer.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef TElementIdentifier ElementIdentifierType
 
typedef TElementWrapperInterface ElementInterfaceType
 
typedef TElementWrapper ElementWrapperType
 
typedef SmartPointer< Self > Pointer
 
typedef PriorityQueueContainer Self
 
typedef VectorContainer
< TElementIdentifier,
TElementWrapper > 		Superclass
 
- Public Types inherited from itk::VectorContainer< TElementIdentifier, TElementWrapper >
typedef SmartPointer< const Self > ConstPointer
 
typedef TElementWrapper Element
 
typedef TElementIdentifier ElementIdentifier
 
typedef SmartPointer< Self > Pointer
 
typedef VectorContainer Self
 
typedef VectorType STLContainerType
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

void Clear ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
bool DeleteElement (const ElementWrapperType &element)
 
bool Empty () const
 
virtual const char * GetNameOfClass () const
 
const ElementWrapperType & Peek () const
 
void Pop ()
 
 PriorityQueueContainer ()
 
template<typename TInputIterator >
 PriorityQueueContainer (TInputIterator first, TInputIterator last)
 
void Push (ElementWrapperType element)
 
bool Update (const ElementWrapperType &element)
 
 ~PriorityQueueContainer ()
 
- Public Member Functions inherited from itk::VectorContainer< TElementIdentifier, TElementWrapper >
ConstIterator Begin (void) const
 
Iterator Begin (void)
 
const STLContainerType & CastToSTLConstContainer () const
 
STLContainerType & CastToSTLContainer ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
Element & CreateElementAt (ElementIdentifier)
 
void CreateIndex (ElementIdentifier)
 
void DeleteIndex (ElementIdentifier)
 
Element & ElementAt (ElementIdentifier)
 
const Element & ElementAt (ElementIdentifier) const
 
ConstIterator End (void) const
 
Iterator End (void)
 
Element GetElement (ElementIdentifier) const
 
bool GetElementIfIndexExists (ElementIdentifier, Element *) const
 
bool IndexExists (ElementIdentifier) const
 
void Initialize (void)
 
void InsertElement (ElementIdentifier, Element)
 
void Reserve (ElementIdentifier)
 
void SetElement (ElementIdentifier, Element)
 
ElementIdentifier Size (void) const
 
void Squeeze (void)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary (void)
 
const MetaDataDictionary & GetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::VectorContainer< TElementIdentifier, TElementWrapper >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const ElementIdentifierType m_ElementNotFound
 

Protected Member Functions

ElementWrapperType & GetElementAtLocation (const ElementIdentifierType &identifier)
 
const ElementWrapperType & GetElementAtLocation (const ElementIdentifierType &identifier) const
 
ElementIdentifierType GetLeft (const ElementIdentifierType &identifier) const
 
ElementIdentifierType GetParent (const ElementIdentifierType &identifier) const
 
ElementIdentifierType GetRight (const ElementIdentifierType &identifier) const
 
bool HasParent (const ElementIdentifierType &iId) const
 
void SetElementAtLocation (const ElementIdentifierType &identifier, ElementWrapperType &element)
 
void UpdateDownTree (const ElementIdentifierType &identifier)
 
void UpdateUpTree (const ElementIdentifierType &identifier)
 
- Protected Member Functions inherited from itk::VectorContainer< TElementIdentifier, TElementWrapper >
 VectorContainer ()
 
 VectorContainer (size_type n)
 
 VectorContainer (size_type n, const Element &x)
 
 VectorContainer (const Self &r)
 
 VectorContainer (TInputIterator first, TInputIterator last)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ElementInterfaceType m_Interface
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef SmartPointer< const Self > itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::ConstPointer

Definition at line 217 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef TElementIdentifier itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::ElementIdentifierType

Definition at line 219 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef TElementWrapperInterface itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::ElementInterfaceType

Definition at line 221 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef TElementWrapper itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::ElementWrapperType

Definition at line 220 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef SmartPointer< Self > itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Pointer

Definition at line 216 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef PriorityQueueContainer itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Self

Definition at line 214 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
typedef VectorContainer< TElementIdentifier, TElementWrapper > itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Superclass

Definition at line 215 of file itkPriorityQueueContainer.h.

Constructor & Destructor Documentation

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::PriorityQueueContainer ( )
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::~PriorityQueueContainer ( )
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
template<typename TInputIterator >
itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::PriorityQueueContainer ( TInputIterator  first,
TInputIterator  last 
)
inline

Definition at line 230 of file itkPriorityQueueContainer.h.

References itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Push().

Member Function Documentation

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
void itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Clear ( )
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
virtual::itk::LightObject::Pointer itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
bool itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::DeleteElement ( const ElementWrapperType &  element)

Delete element in the container.

Returns
true if the element is in the priority queue
false else
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
bool itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Empty ( ) const
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
ElementWrapperType& itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::GetElementAtLocation ( const ElementIdentifierType &  identifier)
inlineprotected

Definition at line 271 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
const ElementWrapperType& itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::GetElementAtLocation ( const ElementIdentifierType &  identifier) const
inlineprotected

Definition at line 276 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
ElementIdentifierType itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::GetLeft ( const ElementIdentifierType &  identifier) const
inlineprotected

Definition at line 293 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
virtual const char* itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::GetNameOfClass ( ) const
virtual

Standard part of every itk Object.

Reimplemented from itk::VectorContainer< TElementIdentifier, TElementWrapper >.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
ElementIdentifierType itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::GetParent ( const ElementIdentifierType &  identifier) const
inlineprotected

Definition at line 288 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
ElementIdentifierType itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::GetRight ( const ElementIdentifierType &  identifier) const
inlineprotected

Definition at line 298 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
bool itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::HasParent ( const ElementIdentifierType &  iId) const
inlineprotected

Definition at line 303 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
static Pointer itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::New ( )
static
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
const ElementWrapperType& itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Peek ( ) const
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
void itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Pop ( )
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
void itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Push ( ElementWrapperType  element)

Referenced by itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::PriorityQueueContainer().

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
void itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::SetElementAtLocation ( const ElementIdentifierType &  identifier,
ElementWrapperType &  element 
)
inlineprotected

Definition at line 281 of file itkPriorityQueueContainer.h.

References itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::m_Interface.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
bool itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::Update ( const ElementWrapperType &  element)

Update element in container.

Returns
true if the element is in the priority queue
false else
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
void itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::UpdateDownTree ( const ElementIdentifierType &  identifier)
protected
template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
void itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::UpdateUpTree ( const ElementIdentifierType &  identifier)
protected

Member Data Documentation

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
const ElementIdentifierType itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::m_ElementNotFound
static

Definition at line 223 of file itkPriorityQueueContainer.h.

template<typename TElementWrapper , typename TElementWrapperInterface , typename TElementPriority = double, typename TElementIdentifier = IdentifierType>
ElementInterfaceType itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::m_Interface
protected

Definition at line 269 of file itkPriorityQueueContainer.h.

Referenced by itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >::SetElementAtLocation().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Mon Jul 21 2014 02:08:57 for ITK by   doxygen 1.8.5