#include <summinfo.h>

Inheritance diagram for OdDbDatabaseSummaryInfo:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbDatabaseSummaryInfo)

	OdDbDatabaseSummaryInfo ()

virtual OdString	getTitle () const =0

virtual void	setTitle (const OdString &title)=0

virtual OdString	getSubject () const =0

virtual void	setSubject (const OdString &subject)=0

virtual OdString	getAuthor () const =0

virtual void	setAuthor (const OdString &author)=0

virtual OdString	getKeywords () const =0

virtual void	setKeywords (const OdString &keywords)=0

virtual OdString	getComments () const =0

virtual void	setComments (const OdString &comments)=0

virtual OdString	getLastSavedBy () const =0

virtual void	setLastSavedBy (const OdString &lastSavedBy)=0

virtual OdString	getRevisionNumber () const =0

virtual void	setRevisionNumber (const OdString &revisionNumber)=0

virtual OdString	getHyperlinkBase () const =0

virtual void	setHyperlinkBase (const OdString &hyperlinkBase)=0

virtual int	numCustomInfo () const =0

virtual void	addCustomSummaryInfo (const OdString &key, const OdString &value)=0

virtual void	deleteCustomSummaryInfo (int fieldIndex)=0

virtual bool	deleteCustomSummaryInfo (const OdString &key)=0

virtual void	getCustomSummaryInfo (int fieldIndex, OdString &key, OdString &rvalue) const =0

virtual void	setCustomSummaryInfo (int fieldIndex, const OdString &key, const OdString &value)=0

virtual bool	getCustomSummaryInfo (const OdString &customInfoKey, OdString &rvalue) const =0

virtual void	setCustomSummaryInfo (const OdString &customInfoKey, const OdString &value)=0

virtual OdDbDatabase *	database () const =0

virtual void	setDatabase (OdDbDatabase *pDb)=0

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

This class encapsulates a set of character strings containing additional information for an OdDbDatabase as Summary Information.

Remarks: In addition to the predefined fields, you add create any number of custom fields to the Summary Information. Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 45 of file summinfo.h.

Constructor & Destructor Documentation

◆ OdDbDatabaseSummaryInfo()

OdDbDatabaseSummaryInfo::OdDbDatabaseSummaryInfo ( )

Member Function Documentation

◆ addCustomSummaryInfo()

virtual void OdDbDatabaseSummaryInfo::addCustomSummaryInfo	(	const OdString &	key,
		const OdString &	value
	)

pure virtual

Appends a custom field to the Summary Information.

Parameters

key	[in] Name of the custom field.
value	[in] Value of the custom field.

◆ database()

virtual OdDbDatabase * OdDbDatabaseSummaryInfo::database ( ) const

pure virtual

Returns the OdDbDatabase associated with this Summary Information.

◆ deleteCustomSummaryInfo() [1/2]

virtual bool OdDbDatabaseSummaryInfo::deleteCustomSummaryInfo ( const OdString & key )

pure virtual

Deletes the specified custom field from the Summary Information.

Parameters

key	[in] Name of the field.

◆ deleteCustomSummaryInfo() [2/2]

virtual void OdDbDatabaseSummaryInfo::deleteCustomSummaryInfo ( int fieldIndex )

pure virtual

Deletes the specified custom field from the Summary Information.

Parameters

fieldIndex [in] Field index [1..numCustomInfo()].

◆ getAuthor()

virtual OdString OdDbDatabaseSummaryInfo::getAuthor ( ) const

pure virtual

Returns the value of the Author field of the Summary Information.

◆ getComments()

virtual OdString OdDbDatabaseSummaryInfo::getComments ( ) const

pure virtual

Returns the value of the Comments field of the Summary Information.

◆ getCustomSummaryInfo() [1/2]

virtual bool OdDbDatabaseSummaryInfo::getCustomSummaryInfo	(	const OdString &	customInfoKey,
		OdString &	rvalue
	)		const

pure virtual

Returns the value of the specified custom field of the Summary Information.

Parameters

customInfoKey	[in] Name of the field to retrieve.
rvalue	[out] Receives the value.

◆ getCustomSummaryInfo() [2/2]

virtual void OdDbDatabaseSummaryInfo::getCustomSummaryInfo	(	int	fieldIndex,
		OdString &	key,
		OdString &	rvalue
	)		const

pure virtual

Returns the value of the specified custom field of the Summary Information.

Parameters

fieldIndex	[in] Field index [1..numCustomInfo()].
key	[out] Receives the name.
rvalue	[out] Receives the value.

◆ getHyperlinkBase()

virtual OdString OdDbDatabaseSummaryInfo::getHyperlinkBase ( ) const

pure virtual

Returns the value of the HyperlinkBase field of the Summary Information.

◆ getKeywords()

virtual OdString OdDbDatabaseSummaryInfo::getKeywords ( ) const

pure virtual

Returns the value of the Keywords field of the Summary Information.

Remarks: Keywords are delimited by spaces.

◆ getLastSavedBy()

virtual OdString OdDbDatabaseSummaryInfo::getLastSavedBy ( ) const

pure virtual

Returns the value of the LastSavedBy field of the Summary Information.

◆ getRevisionNumber()

virtual OdString OdDbDatabaseSummaryInfo::getRevisionNumber ( ) const

pure virtual

Returns the value of the RevisionNumber field of the Summary Information.

Remarks: The RevisionNumber field is returned as a string.

◆ getSubject()

virtual OdString OdDbDatabaseSummaryInfo::getSubject ( ) const

pure virtual

Returns the value of the Subject field of the Summary Information.

◆ getTitle()

virtual OdString OdDbDatabaseSummaryInfo::getTitle ( ) const

pure virtual

Returns the value of the Title field of the Summary Information.

◆ numCustomInfo()

virtual int OdDbDatabaseSummaryInfo::numCustomInfo ( ) const

pure virtual

Returns the number of custom fields in the Summary Information

◆ ODRX_DECLARE_MEMBERS()

OdDbDatabaseSummaryInfo::ODRX_DECLARE_MEMBERS ( OdDbDatabaseSummaryInfo )

◆ setAuthor()

virtual void OdDbDatabaseSummaryInfo::setAuthor ( const OdString & author )

pure virtual

Sets the value of the Author field of the Summary Information.

Parameters

author [in] Author.

◆ setComments()

virtual void OdDbDatabaseSummaryInfo::setComments ( const OdString & comments )

pure virtual

Sets the value of the Comments field of the Summary Information.

Parameters

comments [in] Comments.

◆ setCustomSummaryInfo() [1/2]

virtual void OdDbDatabaseSummaryInfo::setCustomSummaryInfo	(	const OdString &	customInfoKey,
		const OdString &	value
	)

pure virtual

Sets the value of the specified custom field of the Summary Information.

Parameters

customInfoKey	[in] Name of the field to set.
value	[in] Value for the field.

◆ setCustomSummaryInfo() [2/2]

virtual void OdDbDatabaseSummaryInfo::setCustomSummaryInfo	(	int	fieldIndex,
		const OdString &	key,
		const OdString &	value
	)

pure virtual

Sets the value of the specified custom field of the Summary Information.

Parameters

fieldIndex	[in] Field index [1..numCustomInfo()].
key	[in] Name of the field.
value	[in] Value for the field.

◆ setDatabase()

virtual void OdDbDatabaseSummaryInfo::setDatabase ( OdDbDatabase * pDb )

pure virtual

Sets the OdDbDatabase associated with this Summary Information.

Parameters

pDb	[in] Pointer to the database.

◆ setHyperlinkBase()

virtual void OdDbDatabaseSummaryInfo::setHyperlinkBase ( const OdString & hyperlinkBase )

pure virtual

Sets the value of the HyperlinkBase field of the Summary Information.

Parameters

hyperlinkBase [in] HyperlinkBase.

◆ setKeywords()

virtual void OdDbDatabaseSummaryInfo::setKeywords ( const OdString & keywords )

pure virtual

Sets the value of the Keywords field of the Summary Information.

Parameters

keywords [in] Keywords.

Remarks: Keywords are delimited by spaces.

◆ setLastSavedBy()

virtual void OdDbDatabaseSummaryInfo::setLastSavedBy ( const OdString & lastSavedBy )

pure virtual

Sets the value of the LastSavedBy field of the Summary Information.

Parameters

lastSavedBy [in] Last Saved By.

◆ setRevisionNumber()

virtual void OdDbDatabaseSummaryInfo::setRevisionNumber ( const OdString & revisionNumber )

pure virtual

Sets the value of the RevisionNumber field of the Summary Information.

Parameters

revisionNumber [in] Revision number.

Remarks: The RevisionNumber field is set as a string.

◆ setSubject()

virtual void OdDbDatabaseSummaryInfo::setSubject ( const OdString & subject )

pure virtual

Sets the value of the Subject field of the Summary Information.

Parameters

subject [in] Subject.

◆ setTitle()

virtual void OdDbDatabaseSummaryInfo::setTitle ( const OdString & title )

pure virtual

Sets the value of the Title field of the Summary Information.

Parameters

title [in] Title.

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

summinfo.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdDbDatabaseSummaryInfo()

Member Function Documentation

◆ addCustomSummaryInfo()

◆ database()

◆ deleteCustomSummaryInfo() [1/2]

◆ deleteCustomSummaryInfo() [2/2]

◆ getAuthor()

◆ getComments()

◆ getCustomSummaryInfo() [1/2]

◆ getCustomSummaryInfo() [2/2]

◆ getHyperlinkBase()

◆ getKeywords()

◆ getLastSavedBy()

◆ getRevisionNumber()

◆ getSubject()

◆ getTitle()

◆ numCustomInfo()

◆ ODRX_DECLARE_MEMBERS()

◆ setAuthor()

◆ setComments()

◆ setCustomSummaryInfo() [1/2]

◆ setCustomSummaryInfo() [2/2]

◆ setDatabase()

◆ setHyperlinkBase()

◆ setKeywords()

◆ setLastSavedBy()

◆ setRevisionNumber()

◆ setSubject()

◆ setTitle()