NamingConvention Class Reference

#include <NamingConvention.hpp>

Public Member Functions
	NamingConvention (String prefix=String(), bool flag_varname=true, bool flag_qualifier=true, bool flag_locator=true, const ELoc &locatorOutType=ELoc::fromKey("Z"), String delim=".", bool cleanSameLocator=true)
	NamingConvention (const NamingConvention &m)
NamingConvention &	operator= (const NamingConvention &m)
virtual	~NamingConvention ()
VectorString	createNames (const VectorString &names, const String &qualifier=String(), int nitems=1) const
void	setNamesAndLocators (Db *dbout, int iattout_start, const String &qualifier=String(), int nitems=1, bool flagSetLocator=true, int locatorShift=0) const
void	setNamesAndLocators (const VectorString &names, Db *dbout, int iattout_start, const String &qualifier=String(), int nitems=1, bool flagSetLocator=true, int locatorShift=0) const
void	setNamesAndLocators (Db *dbout, int iattout_start, const VectorString &names, bool flagSetLocator=true, int locatorShift=0) const
void	setNamesAndLocators (const String &namin, Db *dbout, int iattout_start, const String &qualifier=String(), int nitems=1, bool flagSetLocator=true, int locatorShift=0) const
void	setNamesAndLocators (const Db *dbin, const ELoc &locatorInType, int nvar, Db *dbout, int iattout_start, const String &qualifier=String(), int nitems=1, bool flagSetLocator=true, int locatorShift=0) const
void	setNamesAndLocators (const Db *dbin, const VectorInt &iatts, Db *dbout, int iattout_start, const String &qualifier=String(), int nitems=1, bool flagSetLocator=true, int locatorShift=0) const
void	setNamesAndLocators (const Db *dbin, int iatt, Db *dbout, int iattout_start, const String &qualifier=String(), int nitems=1, bool flagSetLocator=true, int locatorShift=0) const
void	setDelim (const String &delim)
void	setLocatorOutType (const ELoc &l)
void	setPrefix (const String &prefix)
void	setFlagClean (bool cleanSameLocator)
void	setLocators (Db *dbout, int iattout_start, int nvar, int nitems=1, int locatorShift=0) const
bool	isFlagQualifier () const
bool	isFlagVarname () const

Static Public Member Functions
static NamingConvention *	create (String prefix=String(), bool flag_varname=true, bool flag_qualifier=true, bool flag_locator=true, const ELoc &locatorOutType=ELoc::fromKey("Z"), String delim=".", bool cleanSameLocator=true)

Private Member Functions
void	_setNames (Db *dbout, int iattout_start, const VectorString &names, const String &qualifier, int nitems) const

Private Attributes
String	_prefix
String	_delim
bool	_flagVarname
bool	_flagQualifier
bool	_flagLocator
ELoc	_locatorOutType
bool	_cleanSameLocator

Constructor & Destructor Documentation

NamingConvention() [1/2]

NamingConvention::NamingConvention	(	String	prefix = String(),
		bool	flag_varname = true,
		bool	flag_qualifier = true,
		bool	flag_locator = true,
		const ELoc &	locatorOutType = ELoc::fromKey("Z"),
		String	delim = ".",
		bool	cleanSameLocator = true
	)

NamingConvention() [2/2]

NamingConvention::NamingConvention

(

const NamingConvention &

m

)

~NamingConvention()

NamingConvention::~NamingConvention ( )

virtual

Member Function Documentation

_setNames()

void NamingConvention::_setNames ( Db *  dbout, int  iattout_start, const VectorString &  names, const String &  qualifier, int  nitems  ) const

private

Defines the names of the output variables. These variables are located in 'dbout'; they have consecutive UIDs, starting from 'iattout_start'

Parameters

dbout	Pointer to the output Db structure
iattout_start	Rank of the first variable to be named
names	Vector of Names (dimension: nvar)
qualifier	Optional qualifier
nitems	Number of items to be renamed

create()

NamingConvention * NamingConvention::create ( String  prefix = String(), bool  flag_varname = true, bool  flag_qualifier = true, bool  flag_locator = true, const ELoc &  locatorOutType = ELoc::fromKey("Z"), String  delim = ".", bool  cleanSameLocator = true  )

static

createNames()

VectorString NamingConvention::createNames	(	const VectorString &	names,
		const String &	qualifier = String(),
		int	nitems = 1
	)		const

Defines the names of the output variables.

Parameters

names	Vector of Names (dimension: nvar)
qualifier	Optional qualifier
nitems	Number of items to be renamed

isFlagQualifier()

bool NamingConvention::isFlagQualifier ( ) const

inline

isFlagVarname()

bool NamingConvention::isFlagVarname ( ) const

inline

operator=()

NamingConvention & NamingConvention::operator=

(

const NamingConvention &

m

)

setDelim()

void NamingConvention::setDelim ( const String &  delim )

inline

setFlagClean()

void NamingConvention::setFlagClean ( bool  cleanSameLocator )

inline

setLocatorOutType()

void NamingConvention::setLocatorOutType ( const ELoc &  l )

inline

setLocators()

void NamingConvention::setLocators	(	Db *	dbout,
		int	iattout_start,
		int	nvar,
		int	nitems = 1,
		int	locatorShift = 0
	)		const

setNamesAndLocators() [1/7]

void NamingConvention::setNamesAndLocators	(	const Db *	dbin,
		const ELoc &	locatorInType,
		int	nvar,
		Db *	dbout,
		int	iattout_start,
		const String &	qualifier = String(),
		int	nitems = 1,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming from a set of variables identified by their locatorType

Parameters

dbin	Pointer to the input Db (kept for symmetry)
locatorInType	Locator Tyoe of the variables in Input Db
nvar	Number of items belonging to the locatorType (if -1, all the items available for this locator are used)
dbout	Pointer to the output Db
iattout_start	Starting attribute index
qualifier	Optional qualifier
nitems	Number of items
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setNamesAndLocators() [2/7]

void NamingConvention::setNamesAndLocators	(	const Db *	dbin,
		const VectorInt &	iatts,
		Db *	dbout,
		int	iattout_start,
		const String &	qualifier = String(),
		int	nitems = 1,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming from a set of variables identified by their attribute indices

Parameters

dbin	Pointer to the input Db (kept for symmetry)
iatts	Vector of attribute indices of the variables in Input Db
dbout	Pointer to the output Db
iattout_start	Starting attribute index
qualifier	Optional qualifier
nitems	Number of items
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setNamesAndLocators() [3/7]

void NamingConvention::setNamesAndLocators	(	const Db *	dbin,
		int	iatt,
		Db *	dbout,
		int	iattout_start,
		const String &	qualifier = String(),
		int	nitems = 1,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming from a set of variables identified by their attribute indices

Parameters

dbin	Pointer to the input Db (kept for symmetry)
iatt	Attribute index of the variables in Input Db
dbout	Pointer to the output Db
iattout_start	Starting attribute index
qualifier	Optional qualifier
nitems	Number of items
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setNamesAndLocators() [4/7]

void NamingConvention::setNamesAndLocators	(	const String &	namin,
		Db *	dbout,
		int	iattout_start,
		const String &	qualifier = String(),
		int	nitems = 1,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming from one variable identified by its names

Parameters

namin	variable name in Input Db
dbout	Pointer to the output Db
iattout_start	Starting attribute index
qualifier	Optional qualifier
nitems	Number of items
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setNamesAndLocators() [5/7]

void NamingConvention::setNamesAndLocators	(	const VectorString &	names,
		Db *	dbout,
		int	iattout_start,
		const String &	qualifier = String(),
		int	nitems = 1,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming from a set of variables identified by their names

Parameters

names	Vector of variable names in Input Db
dbout	Pointer to the output Db
iattout_start	Starting attribute index
qualifier	Optional qualifier
nitems	Number of items
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setNamesAndLocators() [6/7]

void NamingConvention::setNamesAndLocators	(	Db *	dbout,
		int	iattout_start,
		const String &	qualifier = String(),
		int	nitems = 1,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming a set of variables of 'dbout' identified by their names

Parameters

dbout	Pointer to the output Db
iattout_start	Starting attribute index
qualifier	Optional qualifier
nitems	Number of items
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setNamesAndLocators() [7/7]

void NamingConvention::setNamesAndLocators	(	Db *	dbout,
		int	iattout_start,
		const VectorString &	names,
		bool	flagSetLocator = true,
		int	locatorShift = 0
	)		const

Naming given the set of output variable names

Parameters

dbout	Pointer to the output Db
iattout_start	Starting attribute index
names	Vector of output variable names
flagSetLocator	True if the variable must be assigned the locator
locatorShift	Shift to be applied to the locator currently defined

setPrefix()

void NamingConvention::setPrefix ( const String &  prefix )

inline

Member Data Documentation

_cleanSameLocator

bool NamingConvention::_cleanSameLocator

private

_delim

String NamingConvention::_delim

private

_flagLocator

bool NamingConvention::_flagLocator

private

_flagQualifier

bool NamingConvention::_flagQualifier

private

_flagVarname

bool NamingConvention::_flagVarname

private

_locatorOutType

ELoc NamingConvention::_locatorOutType

private

_prefix

String NamingConvention::_prefix

private

---

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

• include/Basic/NamingConvention.hpp
• src/Basic/NamingConvention.cpp