PtrGeos.cpp File Reference

#include "Db/PtrGeos.hpp"
#include "Basic/AStringable.hpp"
#include "Basic/String.hpp"
#include "Basic/Utilities.hpp"
#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_locatorIndex, int *ret_mult)
void	printLocatorList ()
VectorString	getLocatorNames ()
VectorInt	getLocatorMultiples ()

Variables
static Def_Locator	DEF_LOCATOR []

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_locatorIndex,
		int *	ret_mult
	)

Given a locator string, extract its characteristics

Parameters

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

Returns

Error code

printLocatorList()

void printLocatorList

(

)

Variable Documentation

DEF_LOCATOR

Def_Locator DEF_LOCATOR[]

static

Initial value:

= { { "x",       0, "Coordinate" },
                                     { "z",       0, "Variable" },
                                     { "v",       0, "Variance of measurement error" },
                                     { "f",       0, "External Drift" },
                                     { "g",       0, "Gradient component" },
                                     { "lower",   0, "Lower bound of an inequality" },
                                     { "upper",   0, "Upper bound of an inequality" },
                                     { "p",       0, "Proportion" },
                                     { "w",       1, "Weight" },
                                     { "code",    1, "Code" },
                                     { "sel",     1, "Selection" },
                                     { "dom",     1, "Domain selection" },
                                     { "dblk",    0, "Block Extension" },
                                     { "adir",    1, "Dip direction angle" },
                                     { "adip",    1, "Dip angle" },
                                     { "size",    1, "Object height" },
                                     { "bu",      1, "Fault UP termination" },
                                     { "bd",      1, "Fault DOWN termination" },
                                     { "time",    0, "Time variable" },
                                     { "layer",   1, "Layer rank" },
                                     { "nostat",  0, "Non-stationary parameter" },
                                     { "tangent", 0, "Tangent" },
                                     { "ncsimu",  0, "Non-conditional simulation" },
                                     { "facies",  0, "Facies simulated" },
                                     { "gausfac", 0, "Gaussian value for Facies" },
                                     { "date",    1, "Date" },
                                     { "rklow",   0, "Disc. rank for Lower bound" },
                                     { "rkup",    0, "Disc. rank for Upper bound" },
                                     { "sum",     0, "Constraints on the sum" }
  }