PtrGeos.hpp File Reference

#include "gstlearn_export.hpp"
#include "geoslib_define.h"
#include "Enum/ELoc.hpp"

Classes
class	PtrGeos

Functions
GSTLEARN_EXPORT int	getLocatorTypeFromName (const String &name_type)
GSTLEARN_EXPORT int	locatorIdentify (String string, ELoc *locatorType, int *locatorIndex, int *mult)
GSTLEARN_EXPORT bool	isLocatorTypeValid (const ELoc &locatorType, bool unknownValid=false)
GSTLEARN_EXPORT String	getLocatorName (const ELoc &locatorType, int locatorIndex=1)
GSTLEARN_EXPORT void	printLocatorList ()
GSTLEARN_EXPORT VectorString	getLocatorNames ()
GSTLEARN_EXPORT VectorInt	getLocatorMultiples ()

Function Documentation

GSTLEARN_EXPORT VectorInt getLocatorMultiples

(

)

GSTLEARN_EXPORT String getLocatorName	(	const ELoc &	locatorType,
		int	locatorIndex
	)

Return the name of Locator

Parameters

locatorType	Type of the Locator (can be negative for 'Rank')
locatorIndex	Rank within the locator starting from 1 (can be <0 for the keyword only)

Returns

GSTLEARN_EXPORT VectorString getLocatorNames

(

)

GSTLEARN_EXPORT int getLocatorTypeFromName

(

const String &

name_type

)

GSTLEARN_EXPORT bool isLocatorTypeValid	(	const ELoc &	locatorType,
		bool	unknownValid
	)

Check if the Locator type is valid or not Note that the locator type is returned as -1 for non identified locator (such as rank)

Parameters

locatorType	The locator type to be identified
unknownValid	True if ELoc::UNKNOWN is considered as valid

Returns

GSTLEARN_EXPORT int locatorIdentify	(	String	string,
		ELoc *	ret_locatorType,
		int *	ret_item,
		int *	ret_mult
	)

Given a locator string, extract its characteristics

Parameters

string	Locator string
ret_locatorType	Resulting Locator type
ret_item	Resulting Locator rank (starting from 0)
ret_mult	Resulting Locator multiplicity (1: unique; 0: multiple)

Returns

Error code

GSTLEARN_EXPORT void printLocatorList

(

)