OdBcf::OdBcfComponents Class Reference

#include <BcfComponents.h>

Inheritance diagram for OdBcf::OdBcfComponents:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfComponents)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
	DECLARE_CONST_ACCESSORS (ViewSetupHints, OdBcfViewSetupHintsPtr, m_pViewSetupHints)
	DECLARE_CONST_ACCESSORS (Selection, OdBcfComponentSelectionPtr, m_pSelection)
	DECLARE_CONST_ACCESSORS (Visibility, OdBcfComponentVisibilityPtr, m_pVisibility)
	DECLARE_CONST_ACCESSORS (Coloring, OdBcfComponentColoringPtr, m_pColoring)
Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)
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< OdBcfComponents >	createObject (const OdBcfComponentVisibilityPtr &pVisibility, const OdBcfViewSetupHintsPtr &pViewSetupHints=OdBcfViewSetupHintsPtr(), const OdBcfComponentSelectionPtr &pSelection=OdBcfComponentSelectionPtr(), const OdBcfComponentColoringPtr &pColoring=OdBcfComponentColoringPtr())
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfViewSetupHintsPtr	m_pViewSetupHints
OdBcfComponentSelectionPtr	m_pSelection
OdBcfComponentVisibilityPtr	m_pVisibility
OdBcfComponentColoringPtr	m_pColoring
friend	OdBcfSession

Detailed Description

A class that contains Components data type.

Definition at line 53 of file BcfComponents.h.

Member Function Documentation

createObject()

static OdSmartPtr<OdBcfComponents> OdBcf::OdBcfComponents::createObject ( const OdBcfComponentVisibilityPtr &  pVisibility, const OdBcfViewSetupHintsPtr &  pViewSetupHints = OdBcfViewSetupHintsPtr(), const OdBcfComponentSelectionPtr &  pSelection = OdBcfComponentSelectionPtr(), const OdBcfComponentColoringPtr &  pColoring = OdBcfComponentColoringPtr()  )

static

Creates a new components object.

Parameters

pVisibility	[in] A pointer to visibility of components.
pViewSetupHints	[in] A pointer to view setup hints of components.
pSelection	[in] A pointer to selection of components.
pColoring	[in] A pointer to coloring of components.

Returns

Returns a smart pointer to the created <link OdBcf::OdBcfComponents, OdBcfComponents> instance.

DECLARE_CONST_ACCESSORS() [1/4]

OdBcf::OdBcfComponents::DECLARE_CONST_ACCESSORS	(	Coloring	,
		OdBcfComponentColoringPtr	,
		m_pColoring
	)

DECLARE_CONST_ACCESSORS() [2/4]

OdBcf::OdBcfComponents::DECLARE_CONST_ACCESSORS	(	Selection	,
		OdBcfComponentSelectionPtr	,
		m_pSelection
	)

DECLARE_CONST_ACCESSORS() [3/4]

OdBcf::OdBcfComponents::DECLARE_CONST_ACCESSORS	(	ViewSetupHints	,
		OdBcfViewSetupHintsPtr	,
		m_pViewSetupHints
	)

DECLARE_CONST_ACCESSORS() [4/4]

OdBcf::OdBcfComponents::DECLARE_CONST_ACCESSORS	(	Visibility	,
		OdBcfComponentVisibilityPtr	,
		m_pVisibility
	)

inFields()

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

virtual

Reads XML data into ODA data structures.

Parameters

pParent

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

Returns

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

Implements OdBcf::OdBcfElement.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfComponents::ODRX_DECLARE_MEMBERS

(

OdBcfComponents

)

outFields()

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

virtual

Writes data into XML structures.

Parameters

pParent

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

Returns

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

Implements OdBcf::OdBcfElement.

validate()

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

virtual

Checks if instance has all required fields initialized.

Returns

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

Implements OdBcf::OdBcfElement.

Member Data Documentation

m_pColoring

OdBcfComponentColoringPtr OdBcf::OdBcfComponents::m_pColoring

protected

Definition at line 105 of file BcfComponents.h.

m_pSelection

OdBcfComponentSelectionPtr OdBcf::OdBcfComponents::m_pSelection

protected

Definition at line 103 of file BcfComponents.h.

m_pViewSetupHints

OdBcfViewSetupHintsPtr OdBcf::OdBcfComponents::m_pViewSetupHints

protected

Definition at line 102 of file BcfComponents.h.

m_pVisibility

OdBcfComponentVisibilityPtr OdBcf::OdBcfComponents::m_pVisibility

protected

Definition at line 104 of file BcfComponents.h.

OdBcfSession

friend OdBcf::OdBcfComponents::OdBcfSession

protected

Definition at line 107 of file BcfComponents.h.

---

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

• BcfComponents.h