PtrGeos.cpp File Reference

#include "Db/PtrGeos.hpp"
#include "Basic/AStringable.hpp"
#include "Basic/String.hpp"
#include "Basic/Utilities.hpp"
#include "geoslib_enum.h"
#include <string.h>
#include <sstream>

Classes
struct	Def_Locator

Functions
String	getLocatorName (const ELoc &locatorType, int locatorIndex)
bool	isLocatorTypeValid (const ELoc &locatorType, bool unknownValid)
int	getLocatorTypeFromName (const String &name_type)
int	locatorIdentify (String string, ELoc *ret_locatorType, int *ret_item, int *ret_mult)
void	printLocatorList ()
VectorString	getLocatorNames ()
VectorInt	getLocatorMultiples ()

Function Documentation

getLocatorMultiples()

VectorInt getLocatorMultiples

(

)

getLocatorName()

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

getLocatorNames()

VectorString getLocatorNames

(

)

getLocatorTypeFromName()

int getLocatorTypeFromName

(

const String &

name_type

)

isLocatorTypeValid()

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

locatorIdentify()

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

printLocatorList()

void printLocatorList

(

)