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

#include <otbExtendedFilenameHelper.h>

+ Inheritance diagram for otb::ExtendedFilenameHelper:
+ Collaboration diagram for otb::ExtendedFilenameHelper:

Classes

struct  GenericBandRange
 

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::map< std::string,
std::string > 
OptionMapType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ExtendedFilenameHelper Self
 
typedef itk::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 const char * GetExtendedFileName () const
 
std::vector
< ExtendedFilenameHelper::GenericBandRange
GetGenericBandRange (const std::string &bandRange) const
 
virtual const char * GetNameOfClass () const
 
const OptionMapTypeGetOptionMap (void) const
 
virtual const char * GetSimpleFileName () const
 
bool ResolveBandRange (const std::string &bandRange, const unsigned int &nbBands, std::vector< unsigned int > &output) const
 
virtual void SetExtendedFileName (const char *extFname)
 
virtual void SetExtendedFileName (const std::string &extFname)
 
- 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
 

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

 ExtendedFilenameHelper ()
 
 ~ExtendedFilenameHelper () override
 
- 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 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 ()
 

Private Member Functions

 ExtendedFilenameHelper (const Self &)=delete
 
void operator= (const Self &)=delete
 
virtual void SetSimpleFileName (const char *_arg)
 

Private Attributes

std::string m_ExtendedFileName
 
OptionMapType m_OptionMap
 
std::string m_SimpleFileName
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

Helper to handle extended filenames.

See Also
ImageFileReader

Definition at line 44 of file otbExtendedFilenameHelper.h.

Member Typedef Documentation

Definition at line 50 of file otbExtendedFilenameHelper.h.

typedef std::map< std::string, std::string > otb::ExtendedFilenameHelper::OptionMapType

Definition at line 54 of file otbExtendedFilenameHelper.h.

Definition at line 49 of file otbExtendedFilenameHelper.h.

Standard class typedefs.

Definition at line 48 of file otbExtendedFilenameHelper.h.

Definition at line 51 of file otbExtendedFilenameHelper.h.

Constructor & Destructor Documentation

otb::ExtendedFilenameHelper::ExtendedFilenameHelper ( )
inlineprotected

Definition at line 93 of file otbExtendedFilenameHelper.h.

otb::ExtendedFilenameHelper::~ExtendedFilenameHelper ( )
inlineoverrideprotected

Definition at line 94 of file otbExtendedFilenameHelper.h.

otb::ExtendedFilenameHelper::ExtendedFilenameHelper ( const Self )
privatedelete

Member Function Documentation

virtual::itk::LightObject::Pointer otb::ExtendedFilenameHelper::CreateAnother ( void  ) const
virtual
virtual const char* otb::ExtendedFilenameHelper::GetExtendedFileName ( ) const
virtual
std::vector<ExtendedFilenameHelper::GenericBandRange> otb::ExtendedFilenameHelper::GetGenericBandRange ( const std::string &  bandRange) const

Decode the string into a list of GenericBandRange, band indexes are 1-based.

virtual const char* otb::ExtendedFilenameHelper::GetNameOfClass ( ) const
virtual
const OptionMapType& otb::ExtendedFilenameHelper::GetOptionMap ( void  ) const
virtual const char* otb::ExtendedFilenameHelper::GetSimpleFileName ( ) const
virtual
static Pointer otb::ExtendedFilenameHelper::New ( )
static
void otb::ExtendedFilenameHelper::operator= ( const Self )
privatedelete
bool otb::ExtendedFilenameHelper::ResolveBandRange ( const std::string &  bandRange,
const unsigned int &  nbBands,
std::vector< unsigned int > &  output 
) const

Resolve the list of band ranges into real band indexes, according to a total number of bands in the image. Note that the output indexes are zero-based (0 is the first component)

virtual void otb::ExtendedFilenameHelper::SetExtendedFileName ( const char *  extFname)
virtual
Deprecated:
const char* overload of SetExtendedFileName is deprecated, use std::string instead

Reimplemented in otb::ExtendedFilenameToWriterOptions, otb::ExtendedFilenameToReaderOptions, and otb::OGRExtendedFilenameToOptions.

virtual void otb::ExtendedFilenameHelper::SetExtendedFileName ( const std::string &  extFname)
virtual
virtual void otb::ExtendedFilenameHelper::SetSimpleFileName ( const char *  _arg)
privatevirtual

Member Data Documentation

std::string otb::ExtendedFilenameHelper::m_ExtendedFileName
private

Definition at line 99 of file otbExtendedFilenameHelper.h.

OptionMapType otb::ExtendedFilenameHelper::m_OptionMap
private

Definition at line 103 of file otbExtendedFilenameHelper.h.

std::string otb::ExtendedFilenameHelper::m_SimpleFileName
private

Definition at line 102 of file otbExtendedFilenameHelper.h.


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