This class is a generic all-purpose wrapping around an std::vector<itk::SmartPointer<ObjectType> >. More...

#include <otbObjectList.h>

Inheritance diagram for otb::ObjectList< TObject >:

Collaboration diagram for otb::ObjectList< TObject >:

Classes
class	ConstIterator
	ConstIterator of the object list. More...
class	Iterator
	Iterator of the object list. More...
class	ReverseConstIterator
	ReverseConstIterator of the object list. More...
class	ReverseIterator
	ReverseIterator of the object list. More...

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer
typedef std::vector < ObjectPointerType >	InternalContainerType
typedef itk::SmartPointer < ObjectType >	ObjectPointerType
typedef TObject	ObjectType
typedef itk::SmartPointer< Self >	Pointer
typedef ObjectList	Self
typedef itk::DataObject	Superclass

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
ObjectPointerType	Back (void)
Iterator	Begin (void)
ConstIterator	Begin (void) const
unsigned int	Capacity (void) const
void	Clear (void)
virtual void	CopyInformation (const DataObject *)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
Iterator	End (void)
ConstIterator	End (void) const
void	Erase (unsigned int index)
void	Erase (Iterator begin, Iterator end)
void	Erase (Iterator loc)
ObjectPointerType	Front (void)
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
ObjectPointerType	GetNthElement (unsigned int index) const
virtual const unsigned long &	GetPipelineMTime ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) const
virtual void	Initialize ()
Iterator	Insert (Iterator position, ObjectPointerType element)
ReverseIterator	Insert (ReverseIterator position, ObjectPointerType element)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	PopBack (void)
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion ()
void	PushBack (ObjectType *element)
virtual void	Register () const
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
void	Reserve (unsigned int size)
virtual void	ResetPipeline ()
void	Resize (unsigned int size)
ReverseIterator	ReverseBegin (void)
ReverseConstIterator	ReverseBegin (void) const
ReverseIterator	ReverseEnd (void)
ReverseConstIterator	ReverseEnd (void) const
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetNthElement (unsigned int index, ObjectPointerType element)
void	SetNthElement (unsigned int index, const ObjectType *element)
void	SetPipelineMTime (unsigned long time)
virtual void	SetReferenceCount (int)
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
unsigned int	Size (void) const
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalReleaseDataFlag ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalReleaseDataFlag (bool val)
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ObjectList ()
	~ObjectList ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, itk::Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	ObjectList (const Self &)
void	operator= (const Self &)

Private Attributes
InternalContainerType	m_InternalContainer

Friends
class	ConstIterator
class	Iterator
class	ReverseConstIterator
class	ReverseIterator

Detailed Description

template<class TObject>
class otb::ObjectList< TObject >

This class is a generic all-purpose wrapping around an std::vector<itk::SmartPointer<ObjectType> >.

ObjectList stores SmartPointer to ObjectType in a std::vector data structure. It provides the same methods and iterators interfaces.

Definition at line 34 of file otbObjectList.h.

Member Typedef Documentation

template<class TObject>

typedef itk::SmartPointer<const Self> otb::ObjectList< TObject >::ConstPointer

Reimplemented from itk::DataObject.

Reimplemented in otb::ImageList< TImage >.

Definition at line 41 of file otbObjectList.h.

template<class TObject>

typedef std::vector<ObjectPointerType> otb::ObjectList< TObject >::InternalContainerType

Definition at line 52 of file otbObjectList.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TObject>

typedef itk::SmartPointer<ObjectType> otb::ObjectList< TObject >::ObjectPointerType

Definition at line 51 of file otbObjectList.h.

template<class TObject>

typedef TObject otb::ObjectList< TObject >::ObjectType

Template parameter typedefs

Definition at line 47 of file otbObjectList.h.

template<class TObject>

typedef itk::SmartPointer<Self> otb::ObjectList< TObject >::Pointer

Reimplemented from itk::DataObject.

Reimplemented in otb::ImageList< TImage >.

Definition at line 40 of file otbObjectList.h.

template<class TObject>

typedef ObjectList otb::ObjectList< TObject >::Self

Standard typedefs

Reimplemented from itk::DataObject.

Reimplemented in otb::ImageList< TImage >.

Definition at line 38 of file otbObjectList.h.

template<class TObject>

typedef itk::DataObject otb::ObjectList< TObject >::Superclass

Reimplemented from itk::DataObject.

Reimplemented in otb::ImageList< TImage >.

Definition at line 39 of file otbObjectList.h.

Constructor & Destructor Documentation

template<class TObject >

otb::ObjectList< TObject >::ObjectList ( )

protected

Constructor

Definition at line 31 of file otbObjectList.txx.

template<class TObject>

otb::ObjectList< TObject >::~ObjectList ( )

inlineprotected

Destructor

Definition at line 576 of file otbObjectList.h.

template<class TObject>

otb::ObjectList< TObject >::ObjectList ( const Self & )

private

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

template<class TObject >

ObjectList< TObject >::ObjectPointerType otb::ObjectList< TObject >::Back ( void )

Return the last element of the list.

Returns:: The last element of the list.

Definition at line 181 of file otbObjectList.txx.

template<class TObject >

ObjectList< TObject >::Iterator otb::ObjectList< TObject >::Begin ( void )

Get an Iterator that points to the beginning of the container.

Returns:: The iterator.

Definition at line 248 of file otbObjectList.txx.

Referenced by otb::BreakAngularPathListFilter< TPath >::GenerateData(), otb::LinkPathListFilter< TPath >::GenerateData(), otb::LikelihoodPathListFilter< TPath, TImage >::GenerateData(), otb::ParallelLinePathListFilter< TPath >::GenerateData(), otb::ImageFittingPolygonListFilter< TPath, TImage >::GenerateData(), and otb::MorphologicalPyramidSynthesisFilter< TInputImage, TOutputImage >::GenerateData().

template<class TObject >

ObjectList< TObject >::ConstIterator otb::ObjectList< TObject >::Begin ( void ) const

Get a ConstIterator that points to the beginning of the container.

Returns:: The iterator.

Definition at line 260 of file otbObjectList.txx.

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TObject >

unsigned int otb::ObjectList< TObject >::Capacity ( void ) const

Get the capacity of the vector.

Returns:: The capacity of the vector.

Definition at line 51 of file otbObjectList.txx.

template<class TObject >

void otb::ObjectList< TObject >::Clear ( void )

Clear the object list.

Definition at line 209 of file otbObjectList.txx.

Referenced by otb::BreakAngularPathListFilter< TPath >::GenerateData(), otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::GenerateData(), otb::ImageToPathListAlignFilter< TInputImage, TOutputPath >::GenerateData(), and otb::PersistentHistogramVectorImageFilter< TInputImage >::Reset().

virtual void itk::DataObject::CopyInformation ( const DataObject * )

inlinevirtualinherited

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 435 of file itkDataObject.h.

template<class TObject>

virtual::itk::LightObject::Pointer otb::ObjectList< TObject >::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.

Reimplemented in otb::ImageList< TImage >.

void itk::DataObject::DataHasBeenGenerated ( )

inherited

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

Definition at line 428 of file itkDataObject.cxx.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

void itk::DataObject::DisconnectPipeline ( )

inherited

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

Definition at line 216 of file itkDataObject.cxx.

template<class TObject >

ObjectList< TObject >::Iterator otb::ObjectList< TObject >::End ( void )

Get an Iterator that points past-the-end of the container.

Returns:: The iterator.

Definition at line 296 of file otbObjectList.txx.

Referenced by otb::BreakAngularPathListFilter< TPath >::GenerateData(), otb::LinkPathListFilter< TPath >::GenerateData(), otb::LikelihoodPathListFilter< TPath, TImage >::GenerateData(), otb::ParallelLinePathListFilter< TPath >::GenerateData(), otb::ImageFittingPolygonListFilter< TPath, TImage >::GenerateData(), and otb::MorphologicalPyramidSynthesisFilter< TInputImage, TOutputImage >::GenerateData().

template<class TObject >

ObjectList< TObject >::ConstIterator otb::ObjectList< TObject >::End ( void ) const

Get a ConstIterator that points past-the-end of the container.

Returns:: The iterator.

Definition at line 308 of file otbObjectList.txx.

template<class TObject >

void otb::ObjectList< TObject >::Erase ( unsigned int index )

Erase the nth element of the list.

Parameters:

index The index of the element to erase.

Erase the nth element in the list.

Parameters:

index The index of the element to erase.

Definition at line 192 of file otbObjectList.txx.

Referenced by otb::LinkPathListFilter< TPath >::GenerateData(), and otb::ParallelLinePathListFilter< TPath >::GenerateData().

template<class TObject >

void otb::ObjectList< TObject >::Erase	(	Iterator	begin,
		Iterator	end
	)

Erase elements from begin to last.

Parameters:

begin	Iterator pointing on first object to erase.
end	Iterator pointing past the last object to erase.

Definition at line 345 of file otbObjectList.txx.

References otb::ObjectList< TObject >::Iterator::GetIter().

template<class TObject >

void otb::ObjectList< TObject >::Erase ( Iterator loc )

Erase loc element.

Parameters:

loc	Iterator pointing on object to erase.

Definition at line 357 of file otbObjectList.txx.

References otb::ObjectList< TObject >::Iterator::GetIter().

template<class TObject >

ObjectList< TObject >::ObjectPointerType otb::ObjectList< TObject >::Front ( void )

Return the first element of the list.

Returns:: The first element of the list.

Definition at line 170 of file otbObjectList.txx.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::DataObject::GetDataReleased ( ) const

inlineinherited

Get the flag indicating the data has been released.

Definition at line 332 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

bool itk::DataObject::GetGlobalReleaseDataFlag ( )

staticinherited

Definition at line 189 of file itkDataObject.cxx.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

template<class TObject>

virtual const char* otb::ObjectList< TObject >::GetNameOfClass ( ) const

virtual

Type macro

Reimplemented from itk::DataObject.

Reimplemented in otb::ImageList< TImage >.

template<class TObject >

ObjectList< TObject >::ObjectPointerType otb::ObjectList< TObject >::GetNthElement ( unsigned int index ) const

Get the nth element of the list.

Parameters:

index The index of the object to get.

Returns:: The pointer to the nth element of the list.

Definition at line 152 of file otbObjectList.txx.

Referenced by otb::SpectralSensitivityReader::GenerateData(), otb::SpectralSensitivityReader::PrintSelf(), otb::Wrapper::InputImageListParameter::SetImageList(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::PersistentHistogramVectorImageFilter< TInputImage >::Synthetize().

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( )

virtualinherited

Referenced by itk::ProcessObject::UpdateOutputInformation().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( )

virtualinherited

SmartPointerForwardReference< ProcessObject > itk::DataObject::GetSource ( void ) const

inherited

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

Definition at line 288 of file itkDataObject.cxx.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const

inherited

Which of the source's outputs corresponds to this data object?

Definition at line 296 of file itkDataObject.cxx.

Referenced by itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion().

unsigned long itk::DataObject::GetUpdateMTime ( ) const

virtualinherited

MTime for the last time this DataObject was generated.

Definition at line 438 of file itkDataObject.cxx.

static void itk::DataObject::GlobalReleaseDataFlagOff ( )

inlinestaticinherited

Definition at line 318 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( )

inlinestaticinherited

Definition at line 316 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::DataObject::Graft ( const DataObject * )

inlinevirtualinherited

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Definition at line 449 of file itkDataObject.h.

Referenced by otb::AtmosphericCorrectionParametersTo6SAtmosphericRadiativeTerms::GraftNthOutput(), otb::VectorDataSource< TOutputVectorData >::GraftNthOutput(), otb::PointSetSource< TOutputPointSet >::GraftNthOutput(), itk::MeshSource< TOutputMesh >::GraftNthOutput(), otb::ObjectListSource< TOutputList >::GraftNthOutput(), and itk::ImageSource< TOutputImage >::GraftNthOutput().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::DataObject::Initialize ( void )

virtualinherited

Restore the data object to its initial state. This means releasing memory.

Definition at line 167 of file itkDataObject.cxx.

template<class TObject >

ObjectList< TObject >::Iterator otb::ObjectList< TObject >::Insert	(	Iterator	position,
		ObjectPointerType	element
	)

Insert an element at a given position

Parameters:

position A random access iterator

Returns:: An iterator that points to the newly insereted element.

Insert an element

Definition at line 221 of file otbObjectList.txx.

References otb::ObjectList< TObject >::Iterator::GetIter().

template<class TObject >

ObjectList< TObject >::ReverseIterator otb::ObjectList< TObject >::Insert	(	ReverseIterator	position,
		ObjectPointerType	element
	)

Insert an element at a given position

Parameters:

position A reverse iterator

Returns:: A reverse iterator that points to the newly insereted element.

Insert an element

Definition at line 234 of file otbObjectList.txx.

References otb::ObjectList< TObject >::ReverseIterator::GetIter().

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TObject>

static Pointer otb::ObjectList< TObject >::New ( )

static

Creation through object factory macro

Reimplemented from itk::Object.

Reimplemented in otb::ImageList< TImage >.

Referenced by otb::Curves2DWidget::Curves2DWidget(), otb::ImageWidgetController::ImageWidgetController(), otb::Wrapper::InputImageListParameter::InputImageListParameter(), otb::Wrapper::InputVectorDataListParameter::InputVectorDataListParameter(), and otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleToHistogramListGenerator().

template<class TObject>

void otb::ObjectList< TObject >::operator= ( const Self & )

private

template<class TObject >

void otb::ObjectList< TObject >::PopBack ( void )

Delete the last element to the list.

Definition at line 96 of file otbObjectList.txx.

virtual void itk::DataObject::PrepareForNewData ( )

inlinevirtualinherited

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 385 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TObject >

void otb::ObjectList< TObject >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

protectedvirtual

PrintSelf method

Reimplemented from itk::DataObject.

Reimplemented in otb::ImageList< TImage >.

Definition at line 367 of file otbObjectList.txx.

References otb::ObjectList< TObject >::ConstIterator::Get(), itk::Indent::GetNextIndent(), and itk::SmartPointer< TObjectType >::GetPointer().

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::DataObject::PropagateRequestedRegion ( void )

virtualinherited

Methods to update the pipeline. Called internally by the pipeline mechanism.

Definition at line 379 of file itkDataObject.cxx.

References itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

void itk::DataObject::PropagateResetPipeline ( )

protectedvirtualinherited

Propagate a call to ResetPipeline(). Called only from ProcessObject.

Definition at line 367 of file itkDataObject.cxx.

template<class TObject >

void otb::ObjectList< TObject >::PushBack ( ObjectType * element )

Append an element to the list.

Parameters:

element Pointer to the element to append.

Definition at line 84 of file otbObjectList.txx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::DataObject::ReleaseData ( )

inherited

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

Definition at line 197 of file itkDataObject.cxx.

virtual void itk::DataObject::ReleaseDataFlagOff ( )

virtualinherited

virtual void itk::DataObject::ReleaseDataFlagOn ( )

virtualinherited

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )

inlinevirtualinherited

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented in itk::ImageBase< VImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::PointSet< TPixel, VDimension, TTraits >, and itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.

Definition at line 409 of file itkDataObject.h.

template<class TObject >

void otb::ObjectList< TObject >::Reserve ( unsigned int size )

Set the minimum capacity of the vector.

Parameters:

size	Size of the vector to reserve.

Definition at line 40 of file otbObjectList.txx.

void itk::DataObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 360 of file itkDataObject.cxx.

template<class TObject >

void otb::ObjectList< TObject >::Resize ( unsigned int size )

Resize the maximal list capacity.

Parameters:

size	The new maximal size of the list.

Definition at line 73 of file otbObjectList.txx.

template<class TObject >

ObjectList< TObject >::ReverseIterator otb::ObjectList< TObject >::ReverseBegin ( void )

Get a ReverseIterator that points to the reverse beginning of the container.

Returns:: The iterator.

Definition at line 272 of file otbObjectList.txx.

Referenced by otb::MorphologicalPyramidSynthesisFilter< TInputImage, TOutputImage >::GenerateData().

template<class TObject >

ObjectList< TObject >::ReverseConstIterator otb::ObjectList< TObject >::ReverseBegin ( void ) const

Get a ReverseConstIterator that points to the reverse beginning of the container.

Returns:: The iterator.

Definition at line 284 of file otbObjectList.txx.

template<class TObject >

ObjectList< TObject >::ReverseIterator otb::ObjectList< TObject >::ReverseEnd ( void )

Get a ReverseIterator that points to the reverse past-the-end of the container.

Returns:: The iterator.

Definition at line 320 of file otbObjectList.txx.

Referenced by otb::MorphologicalPyramidSynthesisFilter< TInputImage, TOutputImage >::GenerateData().

template<class TObject >

ObjectList< TObject >::ReverseConstIterator otb::ObjectList< TObject >::ReverseEnd ( void ) const

Get a ReverseConstIterator that points to the reverse past-the-end of the container.

Returns:: The iterator.

Definition at line 332 of file otbObjectList.txx.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

void itk::DataObject::SetGlobalReleaseDataFlag ( bool val )

staticinherited

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 177 of file itkDataObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

template<class TObject >

void otb::ObjectList< TObject >::SetNthElement	(	unsigned int	index,
		ObjectPointerType	element
	)

Set the nth element of the list.

Parameters:

index	The index where to put the element.
element	Pointer to the element to set.

Definition at line 113 of file otbObjectList.txx.

template<class TObject >

void otb::ObjectList< TObject >::SetNthElement	(	unsigned int	index,
		const ObjectType *	element
	)

Set the nth element of the list.

Parameters:

index	The index where to put the element.
element	Pointer to the element to set.

Definition at line 132 of file otbObjectList.txx.

void itk::DataObject::SetPipelineMTime ( unsigned long time )

inlineinherited

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 370 of file itkDataObject.h.

Referenced by itk::ProcessObject::UpdateOutputInformation().

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::DataObject::SetReleaseDataFlag ( bool flag )

inlineinherited

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegion ( DataObject * )

inlinevirtualinherited

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 442 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( )

inlinevirtualinherited

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 398 of file itkDataObject.h.

bool itk::DataObject::ShouldIReleaseData ( ) const

inherited

Return flag indicating whether data should be released after use by a filter.

Definition at line 206 of file itkDataObject.cxx.

template<class TObject >

unsigned int otb::ObjectList< TObject >::Size ( void ) const

Get the number of elements in the vector.

Returns:: The number of elements in the vector.

Definition at line 62 of file otbObjectList.txx.

Referenced by otb::SpectralSensitivityReader::PrintSelf(), otb::Wrapper::InputImageListParameter::SetImageList(), and otb::Wrapper::InputVectorDataListParameter::SetVectorDataList().

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::DataObject::Update ( void )

virtualinherited

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

Definition at line 340 of file itkDataObject.cxx.

Referenced by itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation().

void itk::DataObject::UpdateOutputData ( void )

virtualinherited

Definition at line 410 of file itkDataObject.cxx.

void itk::DataObject::UpdateOutputInformation ( void )

virtualinherited

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

Definition at line 350 of file itkDataObject.cxx.

Referenced by otb::Wrapper::InputVectorDataListParameter::AddVectorData(), and itk::ProcessObject::UpdateOutputInformation().

virtual bool itk::DataObject::VerifyRequestedRegion ( )

inlinevirtualinherited

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Definition at line 424 of file itkDataObject.h.

Friends And Related Function Documentation

template<class TObject>

friend class ConstIterator

friend

Reimplemented in otb::ImageList< TImage >.

Definition at line 121 of file otbObjectList.h.

template<class TObject>

friend class Iterator

friend

Reimplemented in otb::ImageList< TImage >.

Definition at line 119 of file otbObjectList.h.

template<class TObject>

friend class ReverseConstIterator

friend

Reimplemented in otb::ImageList< TImage >.

Definition at line 123 of file otbObjectList.h.

template<class TObject>

friend class ReverseIterator

friend

Reimplemented in otb::ImageList< TImage >.

Definition at line 122 of file otbObjectList.h.

Member Data Documentation

template<class TObject>

InternalContainerType otb::ObjectList< TObject >::m_InternalContainer

private

The internal std::vector object container

Definition at line 584 of file otbObjectList.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

template<class TObject> class otb::ObjectList< TObject >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class TObject>
class otb::ObjectList< TObject >