oofTime Class Reference
[Local variables compatible with database fields.]

#include <oof4.h>

Inheritance diagram for oofTime:

[legend]Collaboration diagram for oofTime:

[legend]List of all members.

---

Detailed Description

Use to have local non-persistent variable of type dbTime.

arithmetic operators
virtual dbTime &	operator++ ()
virtual dbTime &	operator-- ()
dbTime &	operator+= (long)
dbTime &	operator-= (long)
[NOHEADER]
dbTime	operator- (long) const
dbTime	operator+ (long) const
search factories
dbQueryTrinary	between (const char *, const char *) const
dbQueryTrinary	between (const dbTime &, const dbTime &) const
dbQueryTrinary	outside (const char *, const char *) const
dbQueryTrinary	outside (const dbTime &, const dbTime &) const
dbQueryBinary	operator== (const char *) const
dbQueryBinary	operator== (const dbTime &) const
dbQueryBinary	operator!= (const char *) const
dbQueryBinary	operator!= (const dbTime &) const
dbQueryBinary	operator< (const char *) const
dbQueryBinary	operator< (const dbTime &) const
dbQueryBinary	operator<= (const char *) const
dbQueryBinary	operator<= (const dbTime &) const
dbQueryBinary	operator> (const char *) const
dbQueryBinary	operator> (const dbTime &) const
dbQueryBinary	operator>= (const char *) const
dbQueryBinary	operator>= (const dbTime &) const
reflective operators
virtual unsigned long	fieldStorageLen () const
virtual OOF_fieldTypes	fieldType () const
virtual OOF_fieldTypes	nativeType () const
current time
std::ostream &	now (std::ostream &os)
dbTime	currentTime ()
void	currentTime2hms (unsigned short &, unsigned short &, unsigned short &)
unsigned short	currentSecond ()
unsigned short	currentMinute ()
unsigned short	currentHour ()
Public Types
enum	FieldIsStandaloneT { eFieldIsStandalone }
enum	{ kKeyLengthAutoCalculated = USHRT_MAX }
Public Member Functions
	oofTime ()
	oofTime (const char *initialTime)
	oofTime (const dbTime &)
	oofTime (const oofTime &)
	oofTime (const tm &)
virtual	~oofTime ()
virtual dbField *	clone () const
oofTime &	operator= (const char *)
oofTime &	operator= (const oofTime &)
oofTime &	operator= (const dbTime &)
oofTime &	operator= (const tm &)
void	operator+= (double)
void	operator-= (double)
long	operator- (const dbTime &) const
dbQueryTrinary	between (long, long) const
dbQueryTrinary	outside (long, long) const
dbQueryBinary	operator== (long) const
dbQueryBinary	operator!= (long) const
dbQueryBinary	operator< (long) const
dbQueryBinary	operator<= (long) const
dbQueryBinary	operator> (long) const
dbQueryBinary	operator>= (long) const
dbTime &	calculateWith (dbTimeCalculator *adoptedCalculator, bool useOnlyForDefaults=false)
dbTimeCalculator *	calculator () const
virtual void	generateTestData (bool generateRandom, unsigned long seedOrCount)
void	setTime (long)
	Stores the value in the mBackend pointer for use in the lightweight subclass oofTime when the field storage isn't connected to a database.
void	setTime (short day, unsigned short hour, unsigned short minute, unsigned short second, unsigned short millisecond)
void	setTime (short day, unsigned short hour, unsigned short minute, unsigned short second)
void	setTime (unsigned short hour, unsigned short minute, unsigned short second)
void	setTime (const tm &unixTime)
void	setTimeToCurrentTime ()
virtual void	copyValueFrom (const dbField *)
virtual void	copyValueIfDifferent (const dbField *)
virtual bool	insert (std::istream &, char fieldSep, char recSep)
	operator long () const
long	getTime () const
void	getTime (short &days, unsigned short &hours, unsigned short &minutes, unsigned short &seconds, unsigned short &milliseconds) const
void	getTime (short &days, unsigned short &hours, unsigned short &minutes, unsigned short &seconds) const
void	getTime (unsigned short &hours, unsigned short &minutes, unsigned short &seconds) const
void	getTime (tm &unixTime) const
long	value () const
virtual dbQueryClause *	valueAsQueryLiteral () const
short	day () const
unsigned short	hour () const
unsigned short	minute () const
unsigned short	second () const
unsigned short	millisecond () const
virtual void	extract (std::ostream &os) const
virtual unsigned long	fieldMinWrapWidth () const
const oofString &	formatMask () const
void	formatMask (const char *)
virtual void	clear ()
dbQueryBinary	equal (long) const
dbQueryBinary	lessThan (long) const
dbQueryBinary	lessThanOrEqual (long) const
dbQueryBinary	greaterThanOrEqual (long) const
dbQueryBinary	greaterThan (long) const
dbQueryBinary	notEqual (long) const
void	operator *= (long)
void	operator *= (double)
void	operator/= (long)
void	operator/= (double)
virtual dbQueryLiteral *	makeQueryLiteral (long) const
virtual void	postCloneTableCleanup ()
virtual oofString	name () const
void	index (const OOF_IndexOptions=kIndexed)
void	indexPartialKeyLen (unsigned short)
void	setName (const char *name)
bool	hasDefaultCalculator () const
void	useCalculatorOnlyForDefaults ()
bool	storesCalculatedValues () const
void	storeCalculatedValues ()
bool	usingCalculator () const
const char *	tableName () const
bool	fieldIsStandalone () const
virtual bool	fieldIsSameTypeAs (const dbField *) const
virtual void	describe (std::ostream &) const
	Provide human-readable information about object.
virtual unsigned long	fieldUsualWrapWidth () const
dbTable *	fieldTable () const
unsigned long	fieldDataLen () const
virtual bool	isEmpty () const
bool	isDirty () const
fieldNumT	fieldNumber () const
virtual const oofString &	fieldName () const
OOF_IndexOptions	fieldIndexOptions () const
bool	fieldIndexIgnoresNulls () const
bool	fieldIndexIsCompressLeading () const
bool	fieldIndexIsCompressPadding () const
virtual bool	fieldIsIndexed () const
bool	fieldIsPartiallyIndexed () const
virtual bool	fieldIsKeywordIndexed () const
virtual bool	fieldIsUniqueIndexed () const
unsigned short	fieldNumIndexes () const
unsigned short	fieldKeyLen () const
bool	caseSensitive () const
virtual bool	fieldIsBlob () const
virtual bool	fieldIsBinary () const
virtual bool	fieldIsVirtual () const
dbField *	equivalentFieldFromTable (dbTable *) const
bool	valueIsDuplicate () const
bool	fieldIsJoinKey () const
	Checks if any relationships in field's table use field as join key.
virtual void	setString (const char *)
virtual void	setNumber (long)
virtual oofString	copyString () const
virtual void	getChars (char *ioBuff, unsigned long &outLen) const
virtual const char *	asChars () const
virtual bool	validateContents ()
virtual oofWordParser *	words () const
void	saveDefaultCalculatedValue ()
void	saveStoredCalculatedValue ()
bool	hidden () const
void	hide (bool hideIt=true)
Static Public Member Functions
bool	checkTime (short day, unsigned short hour, unsigned short minute, unsigned short second, unsigned short millisecond)
void	long2dhmsm (long binaryTime, short &day, unsigned short &hour, unsigned short &minute, unsigned short &second, unsigned short &millisecond)
long	dhmsm2long (short day, unsigned short hour, unsigned short minute, unsigned short second, unsigned short millisecond)
long	str2long (const char *str)
bool	str2dhmsm (const char *str, short &day, unsigned short &hour, unsigned short &minute, unsigned short &second, unsigned short &millisecond)
bool	istream2dhmsm (std::istream &is, short &day, unsigned short &hour, unsigned short &minute, unsigned short &second, unsigned short &millisecond)
bool	istream2dhmsm (std::istream &is, short &day, unsigned short &hour, unsigned short &minute, unsigned short &second, unsigned short &millisecond, char fieldSep, char recSep)
std::ostream &	hms2stream (unsigned short hour, unsigned short minute, unsigned short second, std::ostream &os)
std::ostream &	hms2stream (unsigned short hour, unsigned short minute, std::ostream &os)
const oofString &	defaultFormatMask ()
void	defaultFormatMask (const oofString &)
TOKEN	get_token (const char **s, const OOF_TOKENTYPE *m, unsigned int len)
void	parseMask (const char *s, TOKEN *r, const OOF_TOKENTYPE *map, unsigned int len)
Public Attributes
OOF_String	mFormatMask
Protected Member Functions
virtual void	CopyCalculatedValueToBuffer ()
void	CalculateWith (dbCalculator *adoptedCalculator, bool useOnlyForDefaults)
Static Protected Member Functions
void	CheckRange (double d, long minL, long maxL, const char *file, int line)
void	CheckRange (long l, long minL, long maxL, const char *file, int line)
void	CheckRange (unsigned long l, unsigned long max, const char *file, int line)
Protected Attributes
OOF_tableBackend *	mBackend
dbTable *	mTable
fieldNumT	mFieldNumber
dbCalculator *	mCalculator
bool	mHidden
Static Protected Attributes
oofString	sDefaultFormatMask

---

Member Enumeration Documentation

anonymous enum [inherited]

Enumeration values: kKeyLengthAutoCalculated

enum dbField::FieldIsStandaloneT [inherited]

Enumeration values: eFieldIsStandalone

---

Constructor & Destructor Documentation

oofTime::oofTime (   )

oofTime::oofTime (  const char *  initialTime  )

oofTime::oofTime (  const dbTime &   )

oofTime::oofTime (  const oofTime &   )

oofTime::oofTime (  const tm &   )

virtual oofTime::~oofTime (   )  [inline, virtual]

---

Member Function Documentation

const char * dbField::asChars (   )  const [virtual, inherited]

Reimplemented in dbChar, and dbText.

dbQueryTrinary dbNumericField::between (  long  , long  )  const [inherited]

dbQueryTrinary dbTime::between (  const dbTime &  , const dbTime &  )  const [inherited]

dbQueryTrinary dbTime::between (  const char *  , const char *  )  const [inherited]

void dbField::CalculateWith (  dbCalculator *  adoptedCalculator, bool  useOnlyForDefaults )  [protected, inherited]

dbTime & dbTime::calculateWith (  dbTimeCalculator *  adoptedCalculator, bool  useOnlyForDefaults = false )  [inherited]

dbTimeCalculator * dbTime::calculator (   )  const [inline, inherited]

bool dbField::caseSensitive (   )  const [inline, inherited]

void dbNumericField::CheckRange (  unsigned long  l, unsigned long  max, const char *  file, int  line )  [static, protected, inherited]

void dbNumericField::CheckRange (  long  l, long  minL, long  maxL, const char *  file, int  line )  [static, protected, inherited]

void dbNumericField::CheckRange (  double  d, long  minL, long  maxL, const char *  file, int  line )  [static, protected, inherited]

bool dbTime::checkTime (  short  day, unsigned short  hour, unsigned short  minute, unsigned short  second, unsigned short  millisecond )  [static, inherited]

void dbNumericField::clear (   )  [virtual, inherited]

Reimplemented from dbField.

dbField * oofTime::clone (   )  const [virtual]

Reimplemented from dbTime.

void dbTime::CopyCalculatedValueToBuffer (   )  [protected, virtual, inherited]

Reimplemented from dbField.

oofString dbField::copyString (   )  const [virtual, inherited]

Reimplemented in dbChar, and dbText.

void dbTime::copyValueFrom (  const dbField *   )  [virtual, inherited]

Reimplemented from dbField.

void dbTime::copyValueIfDifferent (  const dbField *   )  [virtual, inherited]

Reimplemented from dbField.

unsigned short dbTime::currentHour (   )  [static, inherited]

unsigned short dbTime::currentMinute (   )  [static, inherited]

unsigned short dbTime::currentSecond (   )  [static, inherited]

dbTime dbTime::currentTime (   )  [static, inherited]

void dbTime::currentTime2hms (  unsigned short &  , unsigned short &  , unsigned short &  )  [static, inherited]

short dbTime::day (   )  const [inherited]

void dbTime::defaultFormatMask (  const oofString &   )  [inline, static, inherited]

const oofString & dbTime::defaultFormatMask (   )  [inline, static, inherited]

void dbField::describe (  std::ostream &  os  )  const [virtual, inherited]

Provide human-readable information about object. Overriden to provide much more detail particularly for dbTable::describe() which provides full schema. Reimplemented from OOF_PublicBase. Reimplemented in dbChar, dbFixedBinary, and dbRelRefBase.

long dbTime::dhmsm2long (  short  day, unsigned short  hour, unsigned short  minute, unsigned short  second, unsigned short  millisecond )  [static, inherited]

dbQueryBinary dbNumericField::equal (  long   )  const [inherited]

dbField * dbField::equivalentFieldFromTable (  dbTable *   )  const [inherited]

void dbTime::extract (  std::ostream &  os  )  const [virtual, inherited]

Reimplemented from dbField.

unsigned long dbField::fieldDataLen (   )  const [inline, inherited]

bool dbField::fieldIndexIgnoresNulls (   )  const [inline, inherited]

bool dbField::fieldIndexIsCompressLeading (   )  const [inline, inherited]

bool dbField::fieldIndexIsCompressPadding (   )  const [inline, inherited]

OOF_IndexOptions dbField::fieldIndexOptions (   )  const [inline, inherited]

bool dbField::fieldIsBinary (   )  const [virtual, inherited]

Reimplemented in dbChar, and dbText.

bool dbField::fieldIsBlob (   )  const [virtual, inherited]

Reimplemented in dbBLOB.

bool dbField::fieldIsIndexed (   )  const [virtual, inherited]

bool dbField::fieldIsJoinKey (   )  const [inherited]

Checks if any relationships in field's table use field as join key. Relatively expensive because it's iterating over all fields but all the function calls below are inline queries so will compile down well in release mode. WARNING Doesn't fan out - if any other tables use this field as a join key then they are doing really weird stuff and the application programmer must add their own checks. This feature originally added to support OOF_repEditSetupVisitor::VisitViewBandBody

bool dbField::fieldIsKeywordIndexed (   )  const [virtual, inherited]

Reimplemented in dbChar, and dbText.

bool dbField::fieldIsPartiallyIndexed (   )  const [inline, inherited]

bool dbField::fieldIsSameTypeAs (  const dbField *   )  const [virtual, inherited]

Reimplemented in dbChar, dbFixedBinary, dbCompoundField, and dbRelRefBase.

bool dbField::fieldIsStandalone (   )  const [inline, inherited]

bool dbField::fieldIsUniqueIndexed (   )  const [virtual, inherited]

bool dbField::fieldIsVirtual (   )  const [virtual, inherited]

Reimplemented in dbCompoundField, and dbRelRefBase.

unsigned short dbField::fieldKeyLen (   )  const [inherited]

unsigned long dbNumericField::fieldMinWrapWidth (   )  const [virtual, inherited]

Reimplemented from dbField.

const oofString & dbField::fieldName (   )  const [inline, virtual, inherited]

Reimplemented in dbRelRefBase.

fieldNumT dbField::fieldNumber (   )  const [inline, inherited]

unsigned short dbField::fieldNumIndexes (   )  const [inline, inherited]

unsigned long dbTime::fieldStorageLen (   )  const [virtual, inherited]

Implements dbField.

dbTable * dbField::fieldTable (   )  const [inherited]

OOF_fieldTypes dbTime::fieldType (   )  const [virtual, inherited]

Implements dbField.

unsigned long dbField::fieldUsualWrapWidth (   )  const [virtual, inherited]

Reimplemented in dbChar, and dbText.

void dbNumericField::formatMask (  const char *   )  [inline, inherited]

const oofString & dbNumericField::formatMask (   )  const [inline, inherited]

void dbTime::generateTestData (  bool  generateRandom, unsigned long  seedOrCount )  [virtual, inherited]

Reimplemented from dbField.

TOKEN dbNumericField::get_token (  const char **  s, const OOF_TOKENTYPE *  m, unsigned int  len )  [static, inherited]

void dbField::getChars (  char *  ioBuff, unsigned long &  outLen )  const [virtual, inherited]

Reimplemented in dbChar, and dbText.

void dbTime::getTime (  tm &  unixTime  )  const [inherited]

void dbTime::getTime (  unsigned short &  hours, unsigned short &  minutes, unsigned short &  seconds )  const [inherited]

void dbTime::getTime (  short &  days, unsigned short &  hours, unsigned short &  minutes, unsigned short &  seconds )  const [inherited]

void dbTime::getTime (  short &  days, unsigned short &  hours, unsigned short &  minutes, unsigned short &  seconds, unsigned short &  milliseconds )  const [inherited]

long dbTime::getTime (   )  const [inline, inherited]

dbQueryBinary dbNumericField::greaterThan (  long   )  const [inherited]

dbQueryBinary dbNumericField::greaterThanOrEqual (  long   )  const [inherited]

bool dbField::hasDefaultCalculator (   )  const [inline, inherited]

bool OOF_PublicBase::hidden (   )  const [inline, inherited]

void OOF_PublicBase::hide (  bool  hideIt = true  )  [inline, inherited]

ostream & dbTime::hms2stream (  unsigned short  hour, unsigned short  minute, std::ostream &  os )  [static, inherited]

ostream & dbTime::hms2stream (  unsigned short  hour, unsigned short  minute, unsigned short  second, std::ostream &  os )  [static, inherited]

unsigned short dbTime::hour (   )  const [inherited]

void dbField::index (  const  OOF_IndexOptions = kIndexed  )  [inherited]

void dbField::indexPartialKeyLen (  unsigned  short  )  [inline, inherited]

bool dbTime::insert (  std::istream &  , char  fieldSep, char  recSep )  [virtual, inherited]

Reimplemented from dbField.

bool dbField::isDirty (   )  const [inherited]

Reimplemented in dbBLOB.

bool dbField::isEmpty (   )  const [virtual, inherited]

Reimplemented in dbChar, dbBLOB, dbDate, and dbDateTime.

bool dbTime::istream2dhmsm (  std::istream &