otb::CoordinateToName Class Reference

#include <otbCoordinateToName.h>

Inheritance diagram for otb::CoordinateToName:

Collaboration diagram for otb::CoordinateToName:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef itk::Point< double, 2 >	PointType
typedef CoordinateToName	Self
typedef itk::Object	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual double	GetLat ()
virtual double	GetLon ()
virtual const char *	GetNameOfClass () const
virtual void	SetLat (double _arg)
virtual void	SetLon (double _arg)

Static Public Member Functions
static Pointer	New ()
double	m_Lon
double	m_Lat
bool	m_Multithread
bool	m_IsValid
double	m_UpdateDistance
std::string	m_PlaceName
std::string	m_CountryName
std::string	m_CurlOutput
CurlHelperInterface::Pointer	m_Curl
itk::MultiThreader::Pointer	m_Threader
bool	SetLonLat (PointType point)
std::string	GetPlaceName () const
std::string	GetCountryName () const
virtual bool	GetMultithread ()
virtual void	SetMultithread (bool _arg)
virtual void	MultithreadOn ()
virtual void	MultithreadOff ()
virtual void	SetCurl (CurlHelperInterface *_arg)
virtual bool	Evaluate ()
	CoordinateToName ()
	~CoordinateToName () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	ParseXMLGeonames (std::string &placeName, std::string &countryName) const
virtual void	DoEvaluate ()
static ITK_THREAD_RETURN_TYPE	ThreadFunction (void *)
	CoordinateToName (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

Retrieve geographical information for longitude and latitude coordinates.

This class can work in asynchronous mode using

MultithreadOn() 

. In this case, the web request does not block the rest of the program.

Definition at line 44 of file otbCoordinateToName.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 50 of file otbCoordinateToName.h.

Pointer

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

Definition at line 49 of file otbCoordinateToName.h.

PointType

typedef itk::Point<double, 2> otb::CoordinateToName::PointType

Definition at line 56 of file otbCoordinateToName.h.

Self

typedef CoordinateToName otb::CoordinateToName::Self

Standard class typedefs.

Definition at line 48 of file otbCoordinateToName.h.

Superclass

typedef itk::Object otb::CoordinateToName::Superclass

Definition at line 52 of file otbCoordinateToName.h.

Constructor & Destructor Documentation

CoordinateToName() [1/2]

otb::CoordinateToName::CoordinateToName ( )

protected

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

~CoordinateToName()

otb::CoordinateToName::~CoordinateToName ( )

inlineoverrideprotected

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 123 of file otbCoordinateToName.h.

CoordinateToName() [2/2]

otb::CoordinateToName::CoordinateToName ( const Self &  )

privatedelete

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Member Function Documentation

CreateAnother()

virtual::itk::LightObject::Pointer otb::CoordinateToName::CreateAnother

(

void

)

const

DoEvaluate()

virtual void otb::CoordinateToName::DoEvaluate ( )

protectedvirtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Evaluate()

virtual bool otb::CoordinateToName::Evaluate ( )

virtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

GetCountryName()

std::string otb::CoordinateToName::GetCountryName ( ) const

inline

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 101 of file otbCoordinateToName.h.

GetLat()

virtual double otb::CoordinateToName::GetLat ( )

virtual

GetLon()

virtual double otb::CoordinateToName::GetLon ( )

virtual

GetMultithread()

virtual bool otb::CoordinateToName::GetMultithread ( )

virtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

GetNameOfClass()

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

virtual

GetPlaceName()

std::string otb::CoordinateToName::GetPlaceName ( ) const

inline

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 89 of file otbCoordinateToName.h.

MultithreadOff()

virtual void otb::CoordinateToName::MultithreadOff ( )

virtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

MultithreadOn()

virtual void otb::CoordinateToName::MultithreadOn ( )

virtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

New()

static Pointer otb::CoordinateToName::New ( )

static

Method for creation through the object factory.

operator=()

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

privatedelete

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

ParseXMLGeonames()

void otb::CoordinateToName::ParseXMLGeonames ( std::string &  placeName, std::string &  countryName  ) const

protected

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

PrintSelf()

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

overrideprotected

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

SetCurl()

virtual void otb::CoordinateToName::SetCurl ( CurlHelperInterface *  _arg )

virtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

SetLat()

virtual void otb::CoordinateToName::SetLat ( double  _arg )

virtual

SetLon()

virtual void otb::CoordinateToName::SetLon ( double  _arg )

virtual

SetLonLat()

bool otb::CoordinateToName::SetLonLat ( PointType  point )

inline

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 70 of file otbCoordinateToName.h.

SetMultithread()

virtual void otb::CoordinateToName::SetMultithread ( bool  _arg )

virtual

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

ThreadFunction()

static ITK_THREAD_RETURN_TYPE otb::CoordinateToName::ThreadFunction ( void *  )

staticprotected

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Member Data Documentation

m_CountryName

std::string otb::CoordinateToName::m_CountryName

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 148 of file otbCoordinateToName.h.

m_Curl

CurlHelperInterface::Pointer otb::CoordinateToName::m_Curl

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 151 of file otbCoordinateToName.h.

m_CurlOutput

std::string otb::CoordinateToName::m_CurlOutput

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 149 of file otbCoordinateToName.h.

m_IsValid

bool otb::CoordinateToName::m_IsValid

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 141 of file otbCoordinateToName.h.

m_Lat

double otb::CoordinateToName::m_Lat

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 138 of file otbCoordinateToName.h.

m_Lon

double otb::CoordinateToName::m_Lon

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 137 of file otbCoordinateToName.h.

m_Multithread

bool otb::CoordinateToName::m_Multithread

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 140 of file otbCoordinateToName.h.

m_PlaceName

std::string otb::CoordinateToName::m_PlaceName

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 147 of file otbCoordinateToName.h.

m_Threader

itk::MultiThreader::Pointer otb::CoordinateToName::m_Threader

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 153 of file otbCoordinateToName.h.

m_UpdateDistance

double otb::CoordinateToName::m_UpdateDistance

private

Set the lon/lat only if they are far enough from the current point to avoid triggering too many updates

Definition at line 145 of file otbCoordinateToName.h.

---

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

• otbCoordinateToName.h