OdBcf::OdBcfComponent Class Reference

#include <BcfComponent.h>

Inheritance diagram for OdBcf::OdBcfComponent:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfComponent)
	OdBcfComponent ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
const OdString &	getIfcGuid () const
bool	isIfcGuidUnset () const
const OdString &	getOriginatingSystem () const
bool	isOriginatingSystemUnset () const
const OdString &	getAuthoringToolId () const
bool	isAuthoringToolIdUnset () 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
OdBcfComponent &	operator= (const OdBcfComponentData &val)

Friends
class	OdBcfSession

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Attributes inherited from OdBcf::OdBcfComponentData
OdString	m_ifcGuid
OdString	m_originatingSystem
OdString	m_authoringToolId
friend	OdBcfSession

Detailed Description

A class that stores and operates a component data type.

Definition at line 57 of file BcfComponent.h.

Constructor & Destructor Documentation

OdBcfComponent()

OdBcf::OdBcfComponent::OdBcfComponent

(

)

Creates a new component object with default parameters.

Member Function Documentation

getAuthoringToolId()

const OdString & OdBcf::OdBcfComponent::getAuthoringToolId

(

)

const

Retrieves the identifier of the authoring tool that was used for the creation of the component object.

Returns

A string that contains the authoring tool identifier.

Remarks

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

getIfcGuid()

const OdString & OdBcf::OdBcfComponent::getIfcGuid

(

)

const

Retrieves the IFC global unique identifier (IfcGUID) of the component object.

Returns

A string that contains the IfcGUID value.

Remarks

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

getOriginatingSystem()

const OdString & OdBcf::OdBcfComponent::getOriginatingSystem

(

)

const

Retrieves the originating system's name of the component object.

Returns

A string that contains the originating system's name.

Remarks

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

inFields()

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

isAuthoringToolIdUnset()

bool OdBcf::OdBcfComponent::isAuthoringToolIdUnset

(

)

const

Defines whether the identifier of the authoring tool that was used for the component object creation is not initialized.

Returns

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

isIfcGuidUnset()

bool OdBcf::OdBcfComponent::isIfcGuidUnset

(

)

const

Defines whether the IFC global unique identifier (IfcGUID) of the component object is not initialized.

Returns

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

isOriginatingSystemUnset()

bool OdBcf::OdBcfComponent::isOriginatingSystemUnset

(

)

const

Defines whether the originating system name is not initialized.

Returns

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

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfComponent::ODRX_DECLARE_MEMBERS

(

OdBcfComponent

)

operator=()

OdBcfComponent & OdBcf::OdBcfComponent::operator= ( const OdBcfComponentData &  val )

protected

outFields()

virtual OdResult OdBcf::OdBcfComponent::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::OdBcfComponent::validate ( ) const

virtual

Checks whether the component instance has all required fields initialized.

Returns

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

Implements OdBcf::OdBcfElement.

Friends And Related Function Documentation

OdBcfSession

friend class OdBcfSession

friend

Definition at line 137 of file BcfComponent.h.

---

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

• BcfComponent.h