DataColDef Class Reference

Column definition in tabular data sets. More...

Public Types
enum	MatchLevel { Exact , Start , None }

Public Member Functions
	DataColDef (const char *nm, const char *ref=nullptr, const UnitOfMeasure *un=nullptr)
	~DataColDef ()
MatchLevel	compare (const DataColDef &, bool use_name) const
	if !use_name, matches ref_ . More...
void	getFrom (const char *)
bool	operator== (const DataColDef &dcd) const
void	putTo (BufferString &) const

Static Public Member Functions
static const DataColDef &	unknown ()

Public Attributes
BufferString	name_
BufferString	ref_
const UnitOfMeasure *	unit_

Detailed Description

Column definition in tabular data sets.

The ref_ is intended for whatever references that are important in the software but which should probably not be displayed to the user.

All but the 'user name' is optional.

<>

Member Enumeration Documentation

MatchLevel

enum DataColDef::MatchLevel

Enumerator
Exact
Start
None

Constructor & Destructor Documentation

DataColDef()

DataColDef::DataColDef	(	const char *	nm,
		const char *	ref = nullptr,
		const UnitOfMeasure *	un = nullptr
	)

~DataColDef()

DataColDef::~DataColDef

(

)

Member Function Documentation

compare()

MatchLevel DataColDef::compare	(	const DataColDef &	,
		bool	use_name
	)		const

if !use_name, matches ref_ .

getFrom()

void DataColDef::getFrom

(

const char *

)

operator==()

bool DataColDef::operator== ( const DataColDef &  dcd ) const

inline

putTo()

void DataColDef::putTo

(

BufferString &

)

const

unknown()

static const DataColDef& DataColDef::unknown ( )

static

Member Data Documentation

name_

BufferString DataColDef::name_

ref_

BufferString DataColDef::ref_

unit_

const UnitOfMeasure* DataColDef::unit_