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< Self >	Pointer
typedef ExtendedFilenameHelper	Self
typedef itk::Object	Superclass

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 OptionMapType &	GetOptionMap (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)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	ExtendedFilenameHelper ()
	~ExtendedFilenameHelper () override

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

Detailed Description

Helper to handle extended filenames.

See also

ImageFileReader

Definition at line 44 of file otbExtendedFilenameHelper.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 50 of file otbExtendedFilenameHelper.h.

OptionMapType

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

Definition at line 54 of file otbExtendedFilenameHelper.h.

Pointer

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

Definition at line 49 of file otbExtendedFilenameHelper.h.

Self

typedef ExtendedFilenameHelper otb::ExtendedFilenameHelper::Self

Standard class typedefs.

Definition at line 48 of file otbExtendedFilenameHelper.h.

Superclass

typedef itk::Object otb::ExtendedFilenameHelper::Superclass

Definition at line 51 of file otbExtendedFilenameHelper.h.

Constructor & Destructor Documentation

ExtendedFilenameHelper() [1/2]

otb::ExtendedFilenameHelper::ExtendedFilenameHelper ( )

inlineprotected

Definition at line 95 of file otbExtendedFilenameHelper.h.

~ExtendedFilenameHelper()

otb::ExtendedFilenameHelper::~ExtendedFilenameHelper ( )

inlineoverrideprotected

Definition at line 98 of file otbExtendedFilenameHelper.h.

ExtendedFilenameHelper() [2/2]

otb::ExtendedFilenameHelper::ExtendedFilenameHelper ( const Self &  )

privatedelete

Member Function Documentation

CreateAnother()

virtual::itk::LightObject::Pointer otb::ExtendedFilenameHelper::CreateAnother

(

void

)

const

GetExtendedFileName()

virtual const char* otb::ExtendedFilenameHelper::GetExtendedFileName ( ) const

virtual

GetGenericBandRange()

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.

GetNameOfClass()

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

virtual

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

GetOptionMap()

const OptionMapType& otb::ExtendedFilenameHelper::GetOptionMap

(

void

)

const

GetSimpleFileName()

virtual const char* otb::ExtendedFilenameHelper::GetSimpleFileName ( ) const

virtual

New()

static Pointer otb::ExtendedFilenameHelper::New ( )

static

operator=()

void otb::ExtendedFilenameHelper::operator= ( const Self &  )

privatedelete

ResolveBandRange()

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)

SetExtendedFileName() [1/2]

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.

SetExtendedFileName() [2/2]

virtual void otb::ExtendedFilenameHelper::SetExtendedFileName ( const std::string &  extFname )

virtual

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

SetSimpleFileName()

virtual void otb::ExtendedFilenameHelper::SetSimpleFileName ( const char *  _arg )

privatevirtual

Member Data Documentation

m_ExtendedFileName

std::string otb::ExtendedFilenameHelper::m_ExtendedFileName

private

Definition at line 105 of file otbExtendedFilenameHelper.h.

m_OptionMap

OptionMapType otb::ExtendedFilenameHelper::m_OptionMap

private

Definition at line 109 of file otbExtendedFilenameHelper.h.

m_SimpleFileName

std::string otb::ExtendedFilenameHelper::m_SimpleFileName

private

Definition at line 108 of file otbExtendedFilenameHelper.h.

---

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

• otbExtendedFilenameHelper.h