OdBcf::OdBcfRoot Class Reference

#include <BcfRoot.h>

Inheritance diagram for OdBcf::OdBcfRoot:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfRoot)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
OdBcfElementPtr	getRoot ()
void	setFilepath (const OdString &filepath)
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

Static Public Member Functions
static OdSmartPtr< OdBcfRoot >	createObject (const OdBcfElementPtr &pRoot)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfElementPtr	m_pRoot
OdString	m_filepath

Detailed Description

A class that implements a root element for all BCF-related XML hierarchies.

Definition at line 39 of file BcfRoot.h.

Member Function Documentation

createObject()

static OdSmartPtr< OdBcfRoot > OdBcf::OdBcfRoot::createObject ( const OdBcfElementPtr &  pRoot )

static

Creates a new root object.

Parameters

pRoot

[in] A smart pointer to the <link OdBcf::OdBcfElement, root element> of hierarchy.

Returns

A smart pointer to the created <link OdBcf::OdBcfRoot, OdBcfRoot> instance.

getRoot()

OdBcfElementPtr OdBcf::OdBcfRoot::getRoot

(

)

Retrieves the root element of the XML data hierarchy.

Returns

A smart pointer to the <link OdBcf::OdBcfRoot, root element>.

inFields()

virtual OdResult OdBcf::OdBcfRoot::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::OdBcfRoot::ODRX_DECLARE_MEMBERS

(

OdBcfRoot

)

outFields()

virtual OdResult OdBcf::OdBcfRoot::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.

setFilepath()

void OdBcf::OdBcfRoot::setFilepath

(

const OdString &

filepath

)

validate()

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

virtual

Checks whether 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_filepath

OdString OdBcf::OdBcfRoot::m_filepath

protected

Definition at line 89 of file BcfRoot.h.

m_pRoot

OdBcfElementPtr OdBcf::OdBcfRoot::m_pRoot

protected

Definition at line 87 of file BcfRoot.h.

---

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

• BcfRoot.h