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

#include <otbCurlHelper.h>

+ Inheritance diagram for otb::CurlHelper:
+ Collaboration diagram for otb::CurlHelper:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef CurlHelper Self
 
typedef CurlHelperInterface Superclass
 
- Public Types inherited from otb::CurlHelperInterface
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef CurlHelperInterface 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 * GetNameOfClass () const
 
virtual long int GetTimeout ()
 
bool IsCurlReturnHttpError (const std::string &url) const
 
int RetrieveFile (const std::ostringstream &urlStream, std::string filename) const override
 
int RetrieveFile (const std::string &urlString, std::string filename) const override
 
int RetrieveFileMulti (const std::vector< std::string > &listURLs, const std::vector< std::string > &listFiles, int maxConnect) const override
 
int RetrieveUrlInMemory (const std::string &urlString, std::string &output) const override
 
virtual void SetTimeout (long int _arg)
 
bool TestUrlAvailability (const std::string &url) const override
 
- 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 otb::CurlHelperInterface
static bool IsCurlAvailable ()
 
static bool IsCurlMultiAvailable ()
 
- 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

 CurlHelper ()
 
 ~CurlHelper () override
 
- Protected Member Functions inherited from otb::CurlHelperInterface
 CurlHelperInterface ()
 
 ~CurlHelperInterface () 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

 CurlHelper (const Self &)=delete
 
void operator= (const Self &)=delete
 

Static Private Member Functions

static vcl_size_t CallbackWriteDataDummy (void *ptr, vcl_size_t size, vcl_size_t nmemb, void *data)
 
static vcl_size_t CallbackWriteDataToFile (void *ptr, vcl_size_t size, vcl_size_t nmemb, void *data)
 
static vcl_size_t CallbackWriteDataToStringStream (void *ptr, vcl_size_t size, vcl_size_t nmemb, void *data)
 

Private Attributes

std::string m_Browser
 
long int m_Timeout
 

Additional Inherited Members

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

Detailed Description

Class to use the curl capabilities from OTB.

This class is responsible for behaving properly when curl is not available, i.e. the compilation should pass, the runtime should not segfault but of course, the behavior will be different.

Definition at line 40 of file otbCurlHelper.h.

Member Typedef Documentation

Definition at line 47 of file otbCurlHelper.h.

Definition at line 46 of file otbCurlHelper.h.

Standard class typedefs.

Definition at line 45 of file otbCurlHelper.h.

Definition at line 48 of file otbCurlHelper.h.

Constructor & Destructor Documentation

otb::CurlHelper::CurlHelper ( )
inlineprotected

Definition at line 72 of file otbCurlHelper.h.

otb::CurlHelper::~CurlHelper ( )
inlineoverrideprotected

Definition at line 76 of file otbCurlHelper.h.

otb::CurlHelper::CurlHelper ( const Self )
privatedelete

Member Function Documentation

static vcl_size_t otb::CurlHelper::CallbackWriteDataDummy ( void *  ptr,
vcl_size_t  size,
vcl_size_t  nmemb,
void *  data 
)
staticprivate
static vcl_size_t otb::CurlHelper::CallbackWriteDataToFile ( void *  ptr,
vcl_size_t  size,
vcl_size_t  nmemb,
void *  data 
)
staticprivate
static vcl_size_t otb::CurlHelper::CallbackWriteDataToStringStream ( void *  ptr,
vcl_size_t  size,
vcl_size_t  nmemb,
void *  data 
)
staticprivate
virtual::itk::LightObject::Pointer otb::CurlHelper::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

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

Reimplemented from otb::CurlHelperInterface.

virtual long int otb::CurlHelper::GetTimeout ( )
virtual
bool otb::CurlHelper::IsCurlReturnHttpError ( const std::string &  url) const
static Pointer otb::CurlHelper::New ( )
static
void otb::CurlHelper::operator= ( const Self )
privatedelete
int otb::CurlHelper::RetrieveFile ( const std::ostringstream &  urlStream,
std::string  filename 
) const
overridevirtual
int otb::CurlHelper::RetrieveFile ( const std::string &  urlString,
std::string  filename 
) const
overridevirtual
int otb::CurlHelper::RetrieveFileMulti ( const std::vector< std::string > &  listURLs,
const std::vector< std::string > &  listFiles,
int  maxConnect 
) const
overridevirtual
int otb::CurlHelper::RetrieveUrlInMemory ( const std::string &  urlString,
std::string &  output 
) const
overridevirtual
virtual void otb::CurlHelper::SetTimeout ( long int  _arg)
virtual
bool otb::CurlHelper::TestUrlAvailability ( const std::string &  url) const
overridevirtual

Member Data Documentation

std::string otb::CurlHelper::m_Browser
private

Definition at line 92 of file otbCurlHelper.h.

long int otb::CurlHelper::m_Timeout
private

Definition at line 93 of file otbCurlHelper.h.


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