OTB  6.7.0
Orfeo Toolbox
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
otb::GeometriesSet Class Reference

#include <otbGeometriesSet.h>

+ Inheritance diagram for otb::GeometriesSet:
+ Collaboration diagram for otb::GeometriesSet:

Public Types

Standard ITK typedefs
typedef GeometriesSet Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

bool IsSet () const
 
Standard macros
virtual const char * GetNameOfClass () const
 
Geometries accessors
void Set (ogr::DataSource::Pointer datasource)
 
void Set (ogr::Layer layer)
 
Application of a command to a geometries set, through a visitor
template<typename Visitor >
Visitor::result_type apply (Visitor const &visitor)
 
template<typename Visitor >
Visitor::result_type apply (Visitor const &visitor) const
 
template<typename Visitor >
Visitor::result_type apply (Visitor const &visitor, Self &visitable)
 
template<typename Visitor >
Visitor::result_type apply (Visitor const &visitor, Self &visitable) const
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- 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
 

Protected Member Functions

 GeometriesSet ()
 
 GeometriesSet (ogr::DataSource::Pointer datasource)
 
 GeometriesSet (ogr::Layer layer)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~GeometriesSet () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 ()
 

Private Types

typedef boost::variant
< ogr::DataSource::Pointer,
ogr::Layer
AnyGeometriesSetType
 

Private Attributes

AnyGeometriesSetType m_GeometriesSet
 
ImageReference m_ImageReference
 

Factory functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
static Pointer New ()
 
static Pointer New (ogr::DataSource::Pointer datasource)
 
static Pointer New (ogr::Layer layer)
 

Image reference (spacing + origin)

typedef ogr::ImageReference
< double > 
ImageReference
 
void SetImageReference (ImageReference const &imageReference)
 
ImageReference const & GetImageReference () const
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

Common ITK type to manipulate any set of geometries: a otb::ogr::DataSource, or a otb::ogr::Layer.

Since
OTB v 3.14.0

Definition at line 38 of file otbGeometriesSet.h.

Member Typedef Documentation

Definition at line 177 of file otbGeometriesSet.h.

Definition at line 47 of file otbGeometriesSet.h.

ImageReference setter.

Definition at line 143 of file otbGeometriesSet.h.

Definition at line 46 of file otbGeometriesSet.h.

Definition at line 44 of file otbGeometriesSet.h.

Definition at line 45 of file otbGeometriesSet.h.

Constructor & Destructor Documentation

otb::GeometriesSet::GeometriesSet ( )
protected

Default constructor. This actual geometries set is an in-memory otb::ogr::DataSource. It needs to be set to a set of geometries if you expect to serialize it or work on a otb::Layer.

When using this construction path, you'll likelly need to Set() the actual geometries set.

otb::GeometriesSet::GeometriesSet ( ogr::DataSource::Pointer  datasource)
protected

Init constructor from a otb::DataSource.

otb::GeometriesSet::GeometriesSet ( ogr::Layer  layer)
protected

Init constructor from a otb::Layer.

otb::GeometriesSet::~GeometriesSet ( )
overrideprotected

Destructor.

Member Function Documentation

template<typename Visitor >
Visitor::result_type otb::GeometriesSet::apply ( Visitor const &  visitor)
inline

Unary visiting function to apply a visitor on any kind of geometies set.

As a GeometriesSet contains either a otb::ogr::DataSource, or a otb::ogr::Layer, one needs to apply a function on either kind of data. This can be done thanks to a specialization of boost::static_visitor<> that has a const operator() that takes either one (or two in case of binary visitors) otb::DataSource or otb::Layer as parameter(s).

Exceptions
Whateveris thrown by the actual visitor.
Template Parameters
Visitortype of the visitor functor.
Parameters
[in]visitorFunctor visitor that shal derive from boost::static_visitor.

Definition at line 96 of file otbGeometriesSet.h.

template<typename Visitor >
Visitor::result_type otb::GeometriesSet::apply ( Visitor const &  visitor) const
inline

Unary visiting function to apply a visitor on any kind of geometies set.

As a GeometriesSet contains either a otb::ogr::DataSource, or a otb::ogr::Layer, one needs to apply a function on either kind of data. This can be done thanks to a specialization of boost::static_visitor<> that has a const operator() that takes either one (or two in case of binary visitors) otb::DataSource or otb::Layer as parameter(s).

Exceptions
Whateveris thrown by the actual visitor.
Template Parameters
Visitortype of the visitor functor.
Parameters
[in]visitorFunctor visitor that shal derive from boost::static_visitor.

Definition at line 106 of file otbGeometriesSet.h.

template<typename Visitor >
Visitor::result_type otb::GeometriesSet::apply ( Visitor const &  visitor,
Self visitable 
)
inline

Binary visiting function to apply a visitor on any kind of geometies set. Unary visiting function to apply a visitor on any kind of geometies set.

As a GeometriesSet contains either a otb::ogr::DataSource, or a otb::ogr::Layer, one needs to apply a function on either kind of data. This can be done thanks to a specialization of boost::static_visitor<> that has a const operator() that takes either one (or two in case of binary visitors) otb::DataSource or otb::Layer as parameter(s).

Exceptions
Whateveris thrown by the actual visitor.
Template Parameters
Visitortype of the visitor functor.
Parameters
[in]visitorFunctor visitor that shal derive from boost::static_visitor.
[in]visitableother geometries set to visit along side with the current geometries set instance.

Definition at line 119 of file otbGeometriesSet.h.

template<typename Visitor >
Visitor::result_type otb::GeometriesSet::apply ( Visitor const &  visitor,
Self visitable 
) const
inline

Binary visiting function to apply a visitor on any kind of geometies set. Unary visiting function to apply a visitor on any kind of geometies set.

As a GeometriesSet contains either a otb::ogr::DataSource, or a otb::ogr::Layer, one needs to apply a function on either kind of data. This can be done thanks to a specialization of boost::static_visitor<> that has a const operator() that takes either one (or two in case of binary visitors) otb::DataSource or otb::Layer as parameter(s).

Exceptions
Whateveris thrown by the actual visitor.
Template Parameters
Visitortype of the visitor functor.
Parameters
[in]visitorFunctor visitor that shal derive from boost::static_visitor.
[in]visitableother geometries set to visit along side with the current geometries set instance.

Definition at line 129 of file otbGeometriesSet.h.

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

ITK method for creation through the object factory.

Reimplemented from itk::Object.

ImageReference const& otb::GeometriesSet::GetImageReference ( ) const
inline

ImageReference getter.

Definition at line 150 of file otbGeometriesSet.h.

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

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

bool otb::GeometriesSet::IsSet ( ) const

Does it contain a geometries set ?.

static Pointer otb::GeometriesSet::New ( )
static

ITK method for creation through the object factory.

static Pointer otb::GeometriesSet::New ( ogr::DataSource::Pointer  datasource)
static

Direct builder from an existing otb::DataSource.

static Pointer otb::GeometriesSet::New ( ogr::Layer  layer)
static

Direct builder from an existing otb::Layer.

void otb::GeometriesSet::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Prints self to stream.

Reimplemented from itk::DataObject.

void otb::GeometriesSet::Set ( ogr::DataSource::Pointer  datasource)
void otb::GeometriesSet::Set ( ogr::Layer  layer)
void otb::GeometriesSet::SetImageReference ( ImageReference const &  imageReference)
inline

ImageReference setter.

Definition at line 146 of file otbGeometriesSet.h.

Member Data Documentation

AnyGeometriesSetType otb::GeometriesSet::m_GeometriesSet
private

Definition at line 178 of file otbGeometriesSet.h.

ImageReference otb::GeometriesSet::m_ImageReference
private

Definition at line 179 of file otbGeometriesSet.h.


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