#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

const OdBcfViewSetupHintsPtr &	getViewSetupHints () const

bool	isViewSetupHintsUnset () const

const OdBcfComponentSelectionPtr &	getSelection () const

bool	isSelectionUnset () const

const OdBcfComponentVisibilityPtr &	getVisibility () const

bool	isVisibilityUnset () const

const OdBcfComponentColoringPtr &	getColoring () const

bool	isColoringUnset () 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

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 stores and operates the 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 smart pointer to the value that determines the visibility of components.
pViewSetupHints	[in] A smart pointer to the value that determines the view setup hints of components.
pSelection	[in] A smart pointer to the selection of components.
pColoring	[in] A smart pointer to the coloring of components.

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

◆ getColoring()

const OdBcfComponentColoringPtr & OdBcf::OdBcfComponents::getColoring ( ) const

Retrieves the coloring of the components.

Returns: A smart pointer to the <link OdBcf::OdBcfComponentColoring, OdBcfComponentColoring> object that represents the coloring the components.

Remarks: The coloring of the components returned by the method can't be modified in the calling subroutine.

◆ getSelection()

const OdBcfComponentSelectionPtr & OdBcf::OdBcfComponents::getSelection ( ) const

Retrieves the components selection.

Returns: A smart pointer to the <link OdBcf::OdBcfComponentSelection, OdBcfComponentSelection> object that represents the selection.

Remarks: The components selection object returned by the method can't be modified in the calling subroutine.

◆ getViewSetupHints()

const OdBcfViewSetupHintsPtr & OdBcf::OdBcfComponents::getViewSetupHints ( ) const

Retrieves the view setup hints of the components.

Returns: A smart pointer to the <link OdBcf::OdBcfViewSetupHints, OdBcfViewSetupHints> object that represents the view setup hints.

Remarks: The view setup hints object returned by the method can't be modified in the calling subroutine.

◆ getVisibility()

const OdBcfComponentVisibilityPtr & OdBcf::OdBcfComponents::getVisibility ( ) const

Retrieves the visibility of the components.

Returns: A smart pointer to the <link OdBcf::OdBcfComponentVisibility, OdBcfComponentVisibility> object that represents the visibility of the components.

Remarks: The visibility of the components returned by the method can't be modified in the calling subroutine.

◆ inFields()

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

◆ isColoringUnset()

bool OdBcf::OdBcfComponents::isColoringUnset ( ) const

Defines whether the coloring of the components is not initialized.

Returns: true if the coloring of the components is not initialized; otherwise, the method returns false.

◆ isSelectionUnset()

bool OdBcf::OdBcfComponents::isSelectionUnset ( ) const

Defines whether the components selection is not initialized.

Returns: true if the components selection is not initialized; otherwise, the method returns false.

◆ isViewSetupHintsUnset()

bool OdBcf::OdBcfComponents::isViewSetupHintsUnset ( ) const

Defines whether the view setup hints of components are not initialized.

Returns: true if the view setup hints are not initialized; otherwise, the method returns false.

◆ isVisibilityUnset()

bool OdBcf::OdBcfComponents::isVisibilityUnset ( ) const

Defines whether the visibility of the components is not initialized.

Returns: true if the visibility of the components is not initialized; otherwise, the method returns false.

◆ 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 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::OdBcfComponents::validate ( ) const

virtual

Checks whether components 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_pColoring

OdBcfComponentColoringPtr OdBcf::OdBcfComponents::m_pColoring

protected

Definition at line 157 of file BcfComponents.h.

◆ m_pSelection

OdBcfComponentSelectionPtr OdBcf::OdBcfComponents::m_pSelection

protected

Definition at line 155 of file BcfComponents.h.

◆ m_pViewSetupHints

OdBcfViewSetupHintsPtr OdBcf::OdBcfComponents::m_pViewSetupHints

protected

Definition at line 154 of file BcfComponents.h.

◆ m_pVisibility

OdBcfComponentVisibilityPtr OdBcf::OdBcfComponents::m_pVisibility

protected

Definition at line 156 of file BcfComponents.h.

◆ OdBcfSession

friend OdBcf::OdBcfComponents::OdBcfSession

protected

Definition at line 159 of file BcfComponents.h.

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

BcfComponents.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ createObject()

◆ getColoring()

◆ getSelection()

◆ getViewSetupHints()

◆ getVisibility()

◆ inFields()

◆ isColoringUnset()

◆ isSelectionUnset()

◆ isViewSetupHintsUnset()

◆ isVisibilityUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ outFields()

◆ validate()

Member Data Documentation

◆ m_pColoring

◆ m_pSelection

◆ m_pViewSetupHints

◆ m_pVisibility

◆ OdBcfSession