OdBcf::OdBcfDocumentReference Class Reference

#include <BcfDocumentReference.h>

Inheritance diagram for OdBcf::OdBcfDocumentReference:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfDocumentReference)
	OdBcfDocumentReference ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)
virtual OdResult	inFields (TiXmlElement *pParent)=0
virtual OdResult	outFields (TiXmlElement *pParent) const =0
virtual bool	validate () const =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

Protected Attributes
OdString	m_referencedDocument
OdString	m_description
OdBcfDocumentReferenceGroup	m_documentReference

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

Detailed Description

A class that stores and operates a document reference data.

Definition at line 40 of file BcfDocumentReference.h.

Constructor & Destructor Documentation

OdBcfDocumentReference()

OdBcf::OdBcfDocumentReference::OdBcfDocumentReference

(

)

Creates a new document reference object with default parameters.

Member Function Documentation

inFields()

virtual OdResult OdBcf::OdBcfDocumentReference::inFields ( TiXmlElement *  pParent )

virtual

Reads XML data into ODA data structures.

Parameters

pParent

[in] A pointer to the parent element of the data structure.

Returns

eOk if data was successfully read; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfDocumentReference::ODRX_DECLARE_MEMBERS

(

OdBcfDocumentReference

)

outFields()

virtual OdResult OdBcf::OdBcfDocumentReference::outFields ( TiXmlElement *  pParent ) const

virtual

Writes data into XML structures.

Parameters

pParent

[in] A pointer to the parent element of the data structure.

Returns

eOk if data was successfully written; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

validate()

virtual bool OdBcf::OdBcfDocumentReference::validate ( ) const

virtual

Checks whether the document reference instance has all required fields initialized.

Returns

true if all required fields are initialized; otherwise the method returns false.

Implements OdBcf::OdBcfElement.

Member Data Documentation

m_description

OdString OdBcf::OdBcfDocumentReference::m_description

protected

Definition at line 76 of file BcfDocumentReference.h.

m_documentReference

OdBcfDocumentReferenceGroup OdBcf::OdBcfDocumentReference::m_documentReference

protected

Definition at line 77 of file BcfDocumentReference.h.

m_referencedDocument

OdString OdBcf::OdBcfDocumentReference::m_referencedDocument

protected

Definition at line 75 of file BcfDocumentReference.h.

---

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

• BcfDocumentReference.h