RVC::DBTABLE::MAKEPARMS Class Reference

Database table creation parameters class. Manages the necessary parameters to create a database table. More...

#include <rvc/dbtable.h>

Inheritance diagram for RVC::DBTABLE::MAKEPARMS:

[legend]

Public Member Functions
	MAKEPARMS (const DBTABLE &Template)
	MAKEPARMS (DBTABLE::ATTACHMENT Attachment=ATTACHMENT_RelatedOnly, CHAR_ENCODING Encoding=CHAR_ENCODING_ASCII, DBTABLE::USAGE Usage=USAGE_UserDefined)
	MAKEPARMS (const DBTABLE::FIELDINFOARRAY &FieldInfoArray, DBTABLE::ATTACHMENT Attachment=ATTACHMENT_RelatedOnly, CHAR_ENCODING Encoding=CHAR_ENCODING_ASCII, DBTABLE::USAGE Usage=USAGE_UserDefined)
virtual	~MAKEPARMS ()
DBTABLE::ATTACHMENT	GetAttachmentType () const
char	GetDelimiter () const
CHAR_ENCODING	GetEncoding () const
const DBTABLE::FIELDINFOARRAY &	GetFieldInfo () const
const MISTRING &	GetLinkFile () const
DBTABLE::LINKTYPE	GetLinkType () const
bool	GetPromptOnAddElement () const
DBTABLE::REFELEM	GetReferenceElement () const
DBTABLE::USAGE	GetUsage () const
bool	GetUseFieldNamesAsHeading () const
void	SetAttachmentType (ATTACHMENT Attachment)
void	SetDelimiter (char delim)
void	SetEncoding (CHAR_ENCODING Encoding)
void	SetFieldInfo (const FIELDINFOARRAY &FieldInfoArray)
void	SetLinkFile (const MISTRING &filename)
void	SetLinkType (LINKTYPE LinkType)
void	SetPromptOnAddElement (bool prompt=true)
void	SetReferenceElement (REFELEM RefElem)
void	SetUsage (USAGE Usage)
void	SetUseFieldNamesAsHeading (bool UseFieldNamesAsHeading)
Protected Member Functions
DBTABLE::FIELDINFOARRAY &	GetFieldArray ()
void	SetLinkObject (const OBJECT &object)
void	SetupRelatedFields (const DBTABLE &RelTable, INT32 RelFieldNum, FIELDINFO::FLAGS RelFieldFlags, INT32 FirstFieldNum, INT32 NumStaticFields, bool UseRelatedSingle)

Detailed Description

Database table creation parameters class. Manages the necessary parameters to create a database table.

Constructor & Destructor Documentation

RVC::DBTABLE::MAKEPARMS::MAKEPARMS	(	const DBTABLE::FIELDINFOARRAY &	FieldInfoArray,
		DBTABLE::ATTACHMENT	Attachment = `ATTACHMENT_RelatedOnly`,
		CHAR_ENCODING	Encoding = `CHAR_ENCODING_ASCII`,
		DBTABLE::USAGE	Usage = `USAGE_UserDefined`
	)			`[inline]`

Constructor.

RVC::DBTABLE::MAKEPARMS::MAKEPARMS	(	DBTABLE::ATTACHMENT	Attachment = `ATTACHMENT_RelatedOnly`,
		CHAR_ENCODING	Encoding = `CHAR_ENCODING_ASCII`,
		DBTABLE::USAGE	Usage = `USAGE_UserDefined`
	)			`[inline]`

Constructor.

RVC::DBTABLE::MAKEPARMS::MAKEPARMS ( const DBTABLE & Template )

Template Constructor.

virtual RVC::DBTABLE::MAKEPARMS::~MAKEPARMS ( ) [inline, virtual]

Member Function Documentation

DBTABLE::ATTACHMENT RVC::DBTABLE::MAKEPARMS::GetAttachmentType ( ) const [inline]

Get attachment type.

Returns:: Table attachment type

char RVC::DBTABLE::MAKEPARMS::GetDelimiter ( ) const [inline]

Get the delimiter for CSV tables if not set, ',' is assumed.

CHAR_ENCODING RVC::DBTABLE::MAKEPARMS::GetEncoding ( ) const [inline]

Get encoding.

Returns:: Table encoding

DBTABLE::FIELDINFOARRAY& RVC::DBTABLE::MAKEPARMS::GetFieldArray ( ) [inline, protected]

const DBTABLE::FIELDINFOARRAY& RVC::DBTABLE::MAKEPARMS::GetFieldInfo ( ) const [inline]

Get field info array.

Returns:: Table field info array

const MISTRING& RVC::DBTABLE::MAKEPARMS::GetLinkFile ( ) const [inline]

Get table link file.

Returns:: Link table file to create

DBTABLE::LINKTYPE RVC::DBTABLE::MAKEPARMS::GetLinkType ( ) const [inline]

Get table link type.

Returns:: Table link type

bool RVC::DBTABLE::MAKEPARMS::GetPromptOnAddElement ( ) const [inline]

Get whether or not this table should "Prompt when adding elements".

DBTABLE::REFELEM RVC::DBTABLE::MAKEPARMS::GetReferenceElement ( ) const [inline]

Get reference element (This table belongs to what element?).

Returns:: Reference flags

DBTABLE::USAGE RVC::DBTABLE::MAKEPARMS::GetUsage ( ) const [inline]

Get table usage.

Returns:: Table usage

bool RVC::DBTABLE::MAKEPARMS::GetUseFieldNamesAsHeading ( ) const [inline]

Get whether to use field names as heading where supported.

void RVC::DBTABLE::MAKEPARMS::SetAttachmentType ( ATTACHMENT Attachment ) [inline]

Set table attachment type.

void RVC::DBTABLE::MAKEPARMS::SetDelimiter ( char delim ) [inline]

Set the delimiter Only used for CSV tables and only necessary if changing it from something other than ','.

void RVC::DBTABLE::MAKEPARMS::SetEncoding ( CHAR_ENCODING Encoding ) [inline]

Set table encoding.

void RVC::DBTABLE::MAKEPARMS::SetFieldInfo ( const FIELDINFOARRAY & FieldInfoArray ) [inline]

Set table field info array.

void RVC::DBTABLE::MAKEPARMS::SetLinkFile ( const MISTRING & filename ) [inline]

Set table link file, see SetLinkType().

void RVC::DBTABLE::MAKEPARMS::SetLinkObject ( const OBJECT & object ) [inline, protected]

void RVC::DBTABLE::MAKEPARMS::SetLinkType ( LINKTYPE LinkType ) [inline]

Set table link type, this will create a new table of this link type.

void RVC::DBTABLE::MAKEPARMS::SetPromptOnAddElement ( bool prompt = true ) [inline]

Set whether or not this table should "Prompt when adding elements".

void RVC::DBTABLE::MAKEPARMS::SetReferenceElement ( REFELEM RefElem ) [inline]

Set table reference elements.

void RVC::DBTABLE::MAKEPARMS::SetupRelatedFields	(	const DBTABLE &	RelTable,
		INT32	RelFieldNum,
		FIELDINFO::FLAGS	RelFieldFlags,
		INT32	FirstFieldNum,
		INT32	NumStaticFields,
		bool	UseRelatedSingle
	)			`[protected]`

Parameters:

RelFieldFlags

FIELDINFO::FLAG_RangeAbove, FIELDINFO::FLAG_RangeBelow

void RVC::DBTABLE::MAKEPARMS::SetUsage ( USAGE Usage ) [inline]

Set table usage.

void RVC::DBTABLE::MAKEPARMS::SetUseFieldNamesAsHeading ( bool UseFieldNamesAsHeading ) [inline]

Set whether to use field names as heading where supported.

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

rvc/dbtable.h

RVC::DBTABLE::MAKEPARMS Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation