OTB  9.0.0
Orfeo Toolbox
List of all members

#include <otbGeometriesSource.h>

+ Inheritance diagram for otb::GeometriesSource:
+ Collaboration diagram for otb::GeometriesSource:

Public Types

Standard ITK typedefs
typedef GeometriesSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
I/O typedefs
typedef GeometriesSet OutputGeometriesType
 

Standard macros

static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

GeometriesSet Output property.

virtual OutputGeometriesTypeGetOutput (void)
 
virtual OutputGeometriesTypeGetOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetOutput (OutputGeometriesType *output, DataObjectPointerArraySizeType idx=0)
 
void PrepareOutputs () override
 
 GeometriesSource ()
 
 ~GeometriesSource () override
 
virtual void DoAllocateOutputs ()
 

Detailed Description

Source of geometries & Root of the geometries filters hierarchy. This class provides a kind of reader for geometries sets.

Unlike others filters, the output has to be built from outside and given to the GeometriesSource. If no output has been defined at the moment the filter begins processing, by default the ogr::DataSource will have have an in-memory storage.

Definition at line 72 of file otbGeometriesSource.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::GeometriesSource::ConstPointer

Definition at line 81 of file otbGeometriesSource.h.

◆ DataObjectPointerArraySizeType

typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::GeometriesSource::DataObjectPointerArraySizeType

Definition at line 82 of file otbGeometriesSource.h.

◆ OutputGeometriesType

Definition at line 87 of file otbGeometriesSource.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::GeometriesSource::Pointer

Definition at line 80 of file otbGeometriesSource.h.

◆ Self

Definition at line 78 of file otbGeometriesSource.h.

◆ Superclass

typedef itk::ProcessObject otb::GeometriesSource::Superclass

Definition at line 79 of file otbGeometriesSource.h.

Constructor & Destructor Documentation

◆ GeometriesSource()

otb::GeometriesSource::GeometriesSource ( )
protected

Default constructor.

Postcondition
Required number of outputs == 1

◆ ~GeometriesSource()

otb::GeometriesSource::~GeometriesSource ( )
overrideprotected

Destructor. Does nothing.

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer otb::GeometriesSource::CreateAnother ( void  ) const

Method for creation through the object factory.

◆ DoAllocateOutputs()

virtual void otb::GeometriesSource::DoAllocateOutputs ( )
protectedvirtual

Ensures that the output geometries are allocated before processing. If the output hasn't been set, at this point, the default output geometries set will be an in-memory ogr::DataSource.

Postcondition
GetOutput() != NULL

◆ GetNameOfClass()

virtual const char* otb::GeometriesSource::GetNameOfClass ( ) const
virtual

◆ GetOutput() [1/2]

virtual OutputGeometriesType* otb::GeometriesSource::GetOutput ( DataObjectPointerArraySizeType  idx)
virtual

Overriding GetOutput() functions

◆ GetOutput() [2/2]

virtual OutputGeometriesType* otb::GeometriesSource::GetOutput ( void  )
virtual

Overriding GetOutput() functions

◆ New()

static Pointer otb::GeometriesSource::New ( )
static

Method for creation through the object factory.

◆ PrepareOutputs()

void otb::GeometriesSource::PrepareOutputs ( )
override

ProcessObject hook Specialized for GeometriesSource. This function makes sure the output(s) is (/are) allocated before initializing them.

Postcondition
GetOutput() != NULL

◆ SetOutput()

virtual void otb::GeometriesSource::SetOutput ( OutputGeometriesType output,
DataObjectPointerArraySizeType  idx = 0 
)
virtual

Output mutator.

Parameters
[in,out]outputGeometriesSource where output result will be written.
[in]idxindex of the output assigned to the GeometriesSource.
Exceptions
std::bad_allocif no new output can be added.

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