gstlrn::DbStringFormat Class Reference

#include <DbStringFormat.hpp>

Inheritance diagram for gstlrn::DbStringFormat:

Public Member Functions
	DbStringFormat (unsigned char params=FLAG_RESUME|FLAG_VARS, const VectorString &names=VectorString(), const 1 &cols=1(), bool useSel=true)
	DbStringFormat (const DbStringFormat &r)
DbStringFormat &	operator= (const DbStringFormat &r)
virtual	~DbStringFormat ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.
const &	getCols () const
bool	getUseSel () const
Id	getMode () const
unsigned char	getParams () const
const VectorString &	getNames () const
void	setCols (const 1 &cols)
void	setUseSel (bool useSel)
void	setMode (Id 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 1 &cols=1(), 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 gstlrn::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 (Id level) const final
Public Member Functions inherited from gstlrn::AStringFormat
	AStringFormat (Id level=1)
	AStringFormat (const String &title)
	AStringFormat (const AStringFormat &r)
AStringFormat &	operator= (const AStringFormat &r)
virtual	~AStringFormat ()
Id	getLevel () const
bool	hasTitle () const
String	getTitle () const
void	setTitle (const String &title)

Static Public Member Functions
static DbStringFormat *	create (unsigned char params=FLAG_RESUME|FLAG_VARS, const VectorString &names=VectorString(), const 1 &cols=1(), bool useSel=true)
static DbStringFormat *	createFromKeys (unsigned char params, const VectorString &names, const 1 &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 1 &cols=1(), bool useSel=true)

Constructor & Destructor Documentation

DbStringFormat() [1/2]

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

DbStringFormat() [2/2]

gstlrn::DbStringFormat::DbStringFormat

(

const DbStringFormat &

r

)

~DbStringFormat()

gstlrn::DbStringFormat::~DbStringFormat ( )

virtual

Member Function Documentation

create()

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

static

createFromFlags()

DbStringFormat * gstlrn::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 1 &  cols = 1(), bool  useSel = true  )

static

createFromKeys()

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

static

getCols()

const & gstlrn::DbStringFormat::getCols ( ) const

inline

getMode()

Id gstlrn::DbStringFormat::getMode ( ) const

inline

getNames()

const VectorString & gstlrn::DbStringFormat::getNames ( ) const

inline

getParams()

unsigned char gstlrn::DbStringFormat::getParams ( ) const

inline

getUseSel()

bool gstlrn::DbStringFormat::getUseSel ( ) const

inline

matchArray()

bool gstlrn::DbStringFormat::matchArray ( ) const

inline

matchExtend()

bool gstlrn::DbStringFormat::matchExtend ( ) const

inline

matchLocator()

bool gstlrn::DbStringFormat::matchLocator ( ) const

inline

matchResume()

bool gstlrn::DbStringFormat::matchResume ( ) const

inline

matchStats()

bool gstlrn::DbStringFormat::matchStats ( ) const

inline

matchVars()

bool gstlrn::DbStringFormat::matchVars ( ) const

inline

operator=()

DbStringFormat & gstlrn::DbStringFormat::operator=

(

const DbStringFormat &

r

)

setArray()

void gstlrn::DbStringFormat::setArray ( )

inline

setCols()

void gstlrn::DbStringFormat::setCols ( const 1 &  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.

setExtend()

void gstlrn::DbStringFormat::setExtend ( )

inline

setFlags()

void gstlrn::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 1 &	cols = 1(),
		bool	useSel = true
	)

setLocator()

void gstlrn::DbStringFormat::setLocator ( )

inline

setMode()

void gstlrn::DbStringFormat::setMode ( Id  mode )

inline

Parameters

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

setNames()

void gstlrn::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.

setParams()

void gstlrn::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

setResume()

void gstlrn::DbStringFormat::setResume ( )

inline

setStats()

void gstlrn::DbStringFormat::setStats ( )

inline

setUseSel()

void gstlrn::DbStringFormat::setUseSel ( bool  useSel )

inline

Using the current Selection or Not

Parameters

useSel

Take the selection into account when true

setVars()

void gstlrn::DbStringFormat::setVars ( )

inline

toString()

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

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

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