#include <DbStringFormat.hpp>

Inheritance diagram for DbStringFormat:

Public Member Functions
	DbStringFormat (unsigned char params=FLAG_RESUME\|FLAG_VARS, const VectorString &names=VectorString(), const VectorInt &cols=VectorInt(), bool useSel=true)

	DbStringFormat (const DbStringFormat &r)

DbStringFormat &	operator= (const DbStringFormat &r)

virtual	~DbStringFormat ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...

const VectorInt &	getCols () const

bool	getUseSel () const

int	getMode () const

unsigned char	getParams () const

const VectorString &	getNames () const

void	setCols (const VectorInt &cols)

void	setUseSel (bool useSel)

void	setMode (int mode)

void	setNames (const VectorString &names)

void	setParams (unsigned char params)

void	setFlags (bool flag_resume=true, bool flag_vars=true, bool flag_extend=false, bool flag_stats=false, bool flag_array=false, bool flag_locator=false, const VectorString &names=VectorString(), const VectorInt &cols=VectorInt(), bool useSel=true)

void	setResume ()

void	setVars ()

void	setExtend ()

void	setStats ()

void	setArray ()

void	setLocator ()

bool	matchResume () const

bool	matchVars () const

bool	matchExtend () const

bool	matchStats () const

bool	matchArray () const

bool	matchLocator () const

Public Member Functions inherited from AStringable
	AStringable ()

	AStringable (const AStringable &r)

AStringable &	operator= (const AStringable &r)

virtual	~AStringable ()

virtual void	display (const AStringFormat *strfmt=nullptr) const final

virtual void	display (int level) const final

Public Member Functions inherited from AStringFormat
	AStringFormat (int level=1)

	AStringFormat (const AStringFormat &r)

AStringFormat &	operator= (const AStringFormat &r)

virtual	~AStringFormat ()

int	getLevel () const

Static Public Member Functions
static DbStringFormat *	create (unsigned char params=FLAG_RESUME\|FLAG_VARS, const VectorString &names=VectorString(), const VectorInt &cols=VectorInt(), bool useSel=true)

static DbStringFormat *	createFromKeys (unsigned char params, const VectorString &names, const VectorInt &cols, bool useSel)

static DbStringFormat *	createFromFlags (bool flag_resume=true, bool flag_vars=true, bool flag_extend=false, bool flag_stats=false, bool flag_array=false, bool flag_locator=false, const VectorString &names=VectorString(), const VectorInt &cols=VectorInt(), bool useSel=true)

Constructor & Destructor Documentation

DbStringFormat::DbStringFormat	(	unsigned char	params = `FLAG_RESUME \| FLAG_VARS`,
		const VectorString &	names = `VectorString()`,
		const VectorInt &	cols = `VectorInt()`,
		bool	useSel = `true`
	)

DbStringFormat::DbStringFormat ( const DbStringFormat & r )

DbStringFormat::~DbStringFormat ( )

virtual

Member Function Documentation

DbStringFormat * DbStringFormat::create	(	unsigned char	params = `FLAG_RESUME \| FLAG_VARS`,
		const VectorString &	names = `VectorString()`,
		const VectorInt &	cols = `VectorInt()`,
		bool	useSel = `true`
	)

static

DbStringFormat * DbStringFormat::createFromFlags	(	bool	flag_resume = `true`,
		bool	flag_vars = `true`,
		bool	flag_extend = `false`,
		bool	flag_stats = `false`,
		bool	flag_array = `false`,
		bool	flag_locator = `false`,
		const VectorString &	names = `VectorString()`,
		const VectorInt &	cols = `VectorInt()`,
		bool	useSel = `true`
	)

static

DbStringFormat * DbStringFormat::createFromKeys	(	unsigned char	params,
		const VectorString &	names,
		const VectorInt &	cols,
		bool	useSel
	)

static

const VectorInt& DbStringFormat::getCols ( ) const

inline

int DbStringFormat::getMode ( ) const

inline

const VectorString& DbStringFormat::getNames ( ) const

inline

unsigned char DbStringFormat::getParams ( ) const

inline

bool DbStringFormat::getUseSel ( ) const

inline

bool DbStringFormat::matchArray ( ) const

inline

bool DbStringFormat::matchExtend ( ) const

inline

bool DbStringFormat::matchLocator ( ) const

inline

bool DbStringFormat::matchResume ( ) const

inline

bool DbStringFormat::matchStats ( ) const

inline

bool DbStringFormat::matchVars ( ) const

inline

DbStringFormat & DbStringFormat::operator= ( const DbStringFormat & r )

void DbStringFormat::setArray ( )

inline

void DbStringFormat::setCols ( const VectorInt & cols )

inline

Reduce the set of variables for which the print is provided

Parameters

cols	Vector of Column indices on which Stats or Array is applied (optional)

Remarks: This selection is performed by Column Rank. It invalidates any possible selection already performed.

void DbStringFormat::setExtend ( )

inline

void DbStringFormat::setFlags	(	bool	flag_resume = `true`,
		bool	flag_vars = `true`,
		bool	flag_extend = `false`,
		bool	flag_stats = `false`,
		bool	flag_array = `false`,
		bool	flag_locator = `false`,
		const VectorString &	names = `VectorString()`,
		const VectorInt &	cols = `VectorInt()`,
		bool	useSel = `true`
	)

void DbStringFormat::setLocator ( )

inline

void DbStringFormat::setMode ( int mode )

inline

Parameters

mode	Way to consider the variable for Stats (1: Real; 2: Categorical)

void DbStringFormat::setNames ( const VectorString & names )

inline

Reduce the set of variables for which the print is provided

Parameters

names Vector of Column names

Remarks: This selection is performed by Variable Name. It invalidates any possible selection already performed.

void DbStringFormat::setParams ( unsigned char params )

inline

Set the String Format parameters

Parameters

params Mask defining the printout

Remarks: The Mask is a combination of DISPLAY_PARAMS, i.e.:; - FLAG_RESUME: for a Summary of the contents; - FLAG_VARS: for the Field Names and Locators; - FLAG_EXTEND: for the area covered by the Db; - FLAG_STATS: for Basic Statistics on the variables; - FLAG_ARRAY: for the extensive printout of the variables

void DbStringFormat::setResume ( )

inline

void DbStringFormat::setStats ( )

inline

void DbStringFormat::setUseSel ( bool useSel )

inline

Using the current Selection or Not

Parameters

useSel Take the selection into account when true

void DbStringFormat::setVars ( )

inline

String DbStringFormat::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

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

include/Db/DbStringFormat.hpp
src/Db/DbStringFormat.cpp

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation