OdBcf::OdBcfProject Class Reference

#include <BcfProject.h>

Inheritance diagram for OdBcf::OdBcfProject:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfProject)
	OdBcfProject ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
void	setName (const OdString &nameValue)
OdString &	getName ()
const OdString &	getName () const
bool	isNameUnset () const
const OdString &	getProjectId () const
bool	isProjectIdUnset () 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
OdString &	getProjectId ()
void	setProjectId (const OdString &projectIdValue)
OdBcfProject &	operator= (const OdBcfProjectData &val)

Protected Attributes
friend	OdBcfSession
Protected Attributes inherited from OdBcf::OdBcfProjectData
OdString	m_projectId
OdString	m_name

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

Definition at line 59 of file BcfProject.h.

Constructor & Destructor Documentation

OdBcfProject()

OdBcf::OdBcfProject::OdBcfProject

(

)

Creates a new project object with default parameters.

Member Function Documentation

getName() [1/2]

OdString & OdBcf::OdBcfProject::getName

(

)

Retrieves the BCF project name.

Returns

A string that contains the project name.

Remarks

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

getName() [2/2]

const OdString & OdBcf::OdBcfProject::getName

(

)

const

Retrieves the BCF project name.

Returns

A string that contains the project name.

Remarks

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

getProjectId() [1/2]

OdString & OdBcf::OdBcfProject::getProjectId ( )

protected

Retrieves ProjectId while allowing changes.

Returns

ProjectId value.

getProjectId() [2/2]

const OdString & OdBcf::OdBcfProject::getProjectId

(

)

const

Retrieves the project identifier.

Returns

A string that contains the project identifier.

Remarks

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

inFields()

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

isNameUnset()

bool OdBcf::OdBcfProject::isNameUnset

(

)

const

Defines whether the BCF project name is not initialized.

Returns

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

isProjectIdUnset()

bool OdBcf::OdBcfProject::isProjectIdUnset

(

)

const

Defines whether the project identifier is not initialized.

Returns

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

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfProject::ODRX_DECLARE_MEMBERS

(

OdBcfProject

)

operator=()

OdBcfProject & OdBcf::OdBcfProject::operator= ( const OdBcfProjectData &  val )

protected

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

Parameters

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

Returns

The reference to the project instance modified by the assignment operation.

outFields()

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

setName()

void OdBcf::OdBcfProject::setName

(

const OdString &

nameValue

)

Sets the BCF project name.

Parameters

nameValue

[in] A string that contains the project name to be set.

setProjectId()

void OdBcf::OdBcfProject::setProjectId ( const OdString &  projectIdValue )

protected

Sets a new ProjectId value.

Parameters

projectIdValue

[in] A new value to set.

validate()

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

virtual

Checks whether the project 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::OdBcfProject::OdBcfSession

protected

Definition at line 156 of file BcfProject.h.

---

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

• BcfProject.h