RVC::STAT_DBFIELD Class Reference

Manages RVC::OBJTYPE_Stat_DbField objects. More...

#include <rvc/statdbfield.h>

Inheritance diagram for RVC::STAT_DBFIELD:

[legend]

List of all members.

Classes
class	FILTER_FIELDNUM
	Filter to determine which object to select based on the field number. More...
Public Member Functions
	STAT_DBFIELD (const STAT_DBFIELD &rhs)
	STAT_DBFIELD ()
virtual	~STAT_DBFIELD ()
INT32	GetFieldNum () const
const STAT_UNIVARIATE &	GetStatistics () const
STAT_DBFIELD &	operator= (const STAT_DBFIELD &rhs)
ERRVALUE	Read (const RVC::DBTABLE &ObjTable, INT32 FieldNum, const CREDENTIALS *pCredentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Write (const RVC::DBTABLE &ObjTable, INT32 FieldNum, const STAT_UNIVARIATE &Stats, const CREDENTIALS *pCredentials RVC_DEFAULT_CREDENTIALS)
Static Public Member Functions
static int	FindAndRead (const RVC::DBTABLE &ObjTable, INT32 FieldNum, STAT_UNIVARIATE &Stats)

---

Detailed Description

Manages RVC::OBJTYPE_Stat_DbField objects.

Valid parents for this class: RVC::OBJTYPE_Table

---

Constructor & Destructor Documentation

RVC::STAT_DBFIELD::STAT_DBFIELD

(

)

Default constructor.

RVC::STAT_DBFIELD::STAT_DBFIELD

(

const STAT_DBFIELD &

rhs

)

Copy constructor.

virtual RVC::STAT_DBFIELD::~STAT_DBFIELD

(

)

[virtual]

Destructor.

---

Member Function Documentation

static int RVC::STAT_DBFIELD::FindAndRead	(	const RVC::DBTABLE &	ObjTable,
		INT32	FieldNum,
		STAT_UNIVARIATE &	Stats
	)			[static]

Find and read statistics for field if exist.

Returns:

TRUE if exists, FALSE if not, < 0 if error.

Parameters:

	ObjTable	Table
	FieldNum	Field number
	Stats	Statistics returned

INT32 RVC::STAT_DBFIELD::GetFieldNum

(

)

const [inline]

Get field number.

const STAT_UNIVARIATE& RVC::STAT_DBFIELD::GetStatistics

(

)

const [inline]

Get statistics.

STAT_DBFIELD& RVC::STAT_DBFIELD::operator=

(

const STAT_DBFIELD &

rhs

)

Assignment.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::STAT_DBFIELD::Read	(	const RVC::DBTABLE &	ObjTable,
		INT32	FieldNum,
		const CREDENTIALS *pCredentials	RVC_DEFAULT_CREDENTIALS
	)

Read statistics for field if exists.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

ERRVALUE RVC::STAT_DBFIELD::Write	(	const RVC::DBTABLE &	ObjTable,
		INT32	FieldNum,
		const STAT_UNIVARIATE &	Stats,
		const CREDENTIALS *pCredentials	RVC_DEFAULT_CREDENTIALS
	)

Write object with stats for specified field.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

---

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

• rvc/statdbfield.h