gstlearn  1.0.0
CCC
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

◆ getLocatorMultiples()

GSTLEARN_EXPORT VectorInt getLocatorMultiples ( )

◆ getLocatorName()

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

Return the name of Locator

Parameters
locatorTypeType of the Locator (can be negative for 'Rank')
locatorIndexRank within the locator starting from 1 (can be <0 for the keyword only)
Returns

◆ getLocatorNames()

GSTLEARN_EXPORT VectorString getLocatorNames ( )

◆ getLocatorTypeFromName()

GSTLEARN_EXPORT int getLocatorTypeFromName ( const String name_type)

◆ isLocatorTypeValid()

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
locatorTypeThe locator type to be identified
unknownValidTrue if ELoc::UNKNOWN is considered as valid
Returns

◆ locatorIdentify()

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

Given a locator string, extract its characteristics

Parameters
stringLocator string
ret_locatorTypeResulting Locator type
ret_itemResulting Locator rank (starting from 0)
ret_multResulting Locator multiplicity (1: unique; 0: multiple)
Returns
Error code

◆ printLocatorList()

GSTLEARN_EXPORT void printLocatorList ( )