OdBcf::OdBcfProjectExtension Class Reference

#include <BcfProjectExtension.h>

Inheritance diagram for OdBcf::OdBcfProjectExtension:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfProjectExtension)
	OdBcfProjectExtension ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
void	setProject (const OdBcfProjectPtr &projectValue)
OdBcfProjectPtr &	getProject ()
const OdBcfProjectPtr &	getProject () const
bool	isProjectUnset () const
const OdString &	getExtensionSchema () const
bool	isExtensionSchemaUnset () const
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 Member Functions
void	setExtensionSchema (const OdString &extensionSchemaValue)
OdString &	getExtensionSchema ()
OdBcfProjectExtension &	operator= (const OdBcfProjectExtensionData &val)

Protected Attributes
friend	OdBcfSession
Protected Attributes inherited from OdBcf::OdBcfProjectExtensionData
OdString	m_extensionSchema
OdBcfProjectPtr	m_pProject

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 project extension data.

Definition at line 65 of file BcfProjectExtension.h.

Constructor & Destructor Documentation

OdBcfProjectExtension()

OdBcf::OdBcfProjectExtension::OdBcfProjectExtension

(

)

Creates a new project extension object with default parameters.

Member Function Documentation

getExtensionSchema() [1/2]

OdString & OdBcf::OdBcfProjectExtension::getExtensionSchema ( )

protected

Retrieves ExtensionSchema while allowing changes.

Returns

ExtensionSchema value.

getExtensionSchema() [2/2]

const OdString & OdBcf::OdBcfProjectExtension::getExtensionSchema

(

)

const

Retrieves the name of the project extension schema.

Returns

A string that contains the name of the schema.

Remarks

The string returned by the method can't be modified in the calling subroutine.

getProject() [1/2]

OdBcfProjectPtr & OdBcf::OdBcfProjectExtension::getProject

(

)

Retrieves the project instance associated with the project extension.

Returns

A smart pointer to the <link OdBcf::OdBcfProject, OdBcfProject> object that represents the project instance.

Remarks

The project instance returned by the method can be modified in the calling subroutine.

getProject() [2/2]

const OdBcfProjectPtr & OdBcf::OdBcfProjectExtension::getProject

(

)

const

Retrieves the project instance associated with the project extension.

Returns

A smart pointer to the <link OdBcf::OdBcfProject, OdBcfProject> object that represents the project instance.

Remarks

The project instance returned by the method can't be modified in the calling subroutine.

inFields()

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

isExtensionSchemaUnset()

bool OdBcf::OdBcfProjectExtension::isExtensionSchemaUnset

(

)

const

Defines whether the name of the project extension schema is not initialized.

Returns

true if the schema name is not initialized; otherwise, the method returns false.

isProjectUnset()

bool OdBcf::OdBcfProjectExtension::isProjectUnset

(

)

const

Defines whether the project instance associated with the project extension is not initialized.

Returns

true if the project instance is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfProjectExtension::ODRX_DECLARE_MEMBERS

(

OdBcfProjectExtension

)

operator=()

OdBcfProjectExtension & OdBcf::OdBcfProjectExtension::operator= ( const OdBcfProjectExtensionData &  val )

protected

An assignment operator for the BCF project extension class that associates specified data with the project extension object.

Parameters

val	[in] An <link OdBcf::OdBcfProjectExtensionData, OdBcfProjectExtensionData> object that contains data that represents the right-hand operand of the assignment operation.

Returns

The reference to the project extension object modified by the assignment operation.

outFields()

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

setExtensionSchema()

void OdBcf::OdBcfProjectExtension::setExtensionSchema ( const OdString &  extensionSchemaValue )

protected

Sets a new ExtensionSchema value.

Parameters

extensionSchemaValue

[in] A new value to set.

setProject()

void OdBcf::OdBcfProjectExtension::setProject

(

const OdBcfProjectPtr &

projectValue

)

Sets the project instance for the project extension.

Parameters

projectValue

[in] A smart pointer to an <link OdBcf::OdBcfProject, OdBcfProject> instance to be set.

validate()

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

virtual

Checks whether the project extension 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

OdBcfSession

friend OdBcf::OdBcfProjectExtension::OdBcfSession

protected

Definition at line 162 of file BcfProjectExtension.h.

---

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

• BcfProjectExtension.h