OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::VectorDataFileWriter< TInputVectorData > Class Template Reference

#include <otbVectorDataFileWriter.h>

+ Inheritance diagram for otb::VectorDataFileWriter< TInputVectorData >:
+ Collaboration diagram for otb::VectorDataFileWriter< TInputVectorData >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TInputVectorData InputVectorDataType
 
typedef itk::SmartPointer< SelfPointer
 
typedef VectorDataFileWriter Self
 
typedef itk::ProcessObject Superclass
 
typedef VectorDataIOBase VectorDataIOBaseType
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateData ()
 
virtual const char * GetNameOfClass () const
 
virtual void Update ()
 
virtual void Write ()
 
void SetInput (const InputVectorDataType *input)
 
const InputVectorDataTypeGetInput (void)
 
const InputVectorDataTypeGetInput (unsigned int idx)
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- 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 (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
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 ITK_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) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- 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::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 Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const
 
 VectorDataFileWriter ()
 
virtual ~VectorDataFileWriter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- 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 ()
 

Protected Attributes

bool m_FactorySpecifiedVectorDataIO
 
std::string m_FileName
 
bool m_UserSpecifiedVectorDataIO
 
VectorDataIOBaseType::Pointer m_VectorDataIO
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

void operator= (const Self &)
 
 VectorDataFileWriter (const Self &)
 

Additional Inherited Members

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

Detailed Description

template<class TInputVectorData>
class otb::VectorDataFileWriter< TInputVectorData >

This class writes vector data file format (shapefile and KML)

Examples:
Projections/VectorDataExtractROIExample.cxx, and Projections/VectorDataProjectionExample.cxx.

Definition at line 66 of file otbVectorDataFileWriter.h.

Member Typedef Documentation

template<class TInputVectorData>
typedef itk::SmartPointer<const Self> otb::VectorDataFileWriter< TInputVectorData >::ConstPointer

Definition at line 74 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
typedef TInputVectorData otb::VectorDataFileWriter< TInputVectorData >::InputVectorDataType

Definition at line 80 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
typedef itk::SmartPointer<Self> otb::VectorDataFileWriter< TInputVectorData >::Pointer

Definition at line 73 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
typedef VectorDataFileWriter otb::VectorDataFileWriter< TInputVectorData >::Self

Standard class typedefs.

Definition at line 71 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
typedef itk::ProcessObject otb::VectorDataFileWriter< TInputVectorData >::Superclass

Definition at line 72 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
typedef VectorDataIOBase otb::VectorDataFileWriter< TInputVectorData >::VectorDataIOBaseType

Definition at line 83 of file otbVectorDataFileWriter.h.

Constructor & Destructor Documentation

template<class TInputVectorData >
otb::VectorDataFileWriter< TInputVectorData >::VectorDataFileWriter ( )
protected

Constructor

Definition at line 35 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData >
otb::VectorDataFileWriter< TInputVectorData >::~VectorDataFileWriter ( )
protectedvirtual

Destructor

Definition at line 48 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData>
otb::VectorDataFileWriter< TInputVectorData >::VectorDataFileWriter ( const Self )
private

Member Function Documentation

template<class TInputVectorData>
virtual::itk::LightObject::Pointer otb::VectorDataFileWriter< TInputVectorData >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TInputVectorData >
void otb::VectorDataFileWriter< TInputVectorData >::GenerateData ( void  )
virtual

Reimplemented from itk::ProcessObject.

Definition at line 187 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData>
virtual const char* otb::VectorDataFileWriter< TInputVectorData >::GetFileName ( ) const
virtual

Specify the name of the output shapefile to write.

template<class TInputVectorData >
const VectorDataFileWriter< TInputVectorData >::InputVectorDataType * otb::VectorDataFileWriter< TInputVectorData >::GetInput ( void  )

Definition at line 67 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData >
const VectorDataFileWriter< TInputVectorData >::InputVectorDataType * otb::VectorDataFileWriter< TInputVectorData >::GetInput ( unsigned int  idx)

Definition at line 82 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData>
virtual const char* otb::VectorDataFileWriter< TInputVectorData >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TInputVectorData>
static Pointer otb::VectorDataFileWriter< TInputVectorData >::New ( )
static

Method for creation through the object factory.

Referenced by otb::Wrapper::OutputVectorDataParameter::InitializeWriters().

template<class TInputVectorData>
void otb::VectorDataFileWriter< TInputVectorData >::operator= ( const Self )
private
template<class TInputVectorData >
void otb::VectorDataFileWriter< TInputVectorData >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 208 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData>
virtual void otb::VectorDataFileWriter< TInputVectorData >::SetFileName ( const char *  _arg)
virtual

Specify the name of the output shapefile to write.

template<class TInputVectorData >
void otb::VectorDataFileWriter< TInputVectorData >::SetInput ( const InputVectorDataType input)

Definition at line 56 of file otbVectorDataFileWriter.txx.

template<class TInputVectorData>
virtual void otb::VectorDataFileWriter< TInputVectorData >::Update ( void  )
inlinevirtual

Reimplemented from itk::ProcessObject.

Definition at line 97 of file otbVectorDataFileWriter.h.

template<class TInputVectorData >
void otb::VectorDataFileWriter< TInputVectorData >::Write ( void  )
virtual

Member Data Documentation

template<class TInputVectorData>
bool otb::VectorDataFileWriter< TInputVectorData >::m_FactorySpecifiedVectorDataIO
protected

Definition at line 116 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
std::string otb::VectorDataFileWriter< TInputVectorData >::m_FileName
protected

Definition at line 113 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
bool otb::VectorDataFileWriter< TInputVectorData >::m_UserSpecifiedVectorDataIO
protected

Definition at line 115 of file otbVectorDataFileWriter.h.

template<class TInputVectorData>
VectorDataIOBaseType::Pointer otb::VectorDataFileWriter< TInputVectorData >::m_VectorDataIO
protected

Definition at line 114 of file otbVectorDataFileWriter.h.


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