OdBcf::OdBcfComponentVisibility Class Reference

#include <BcfComponentVisibility.h>

Inheritance diagram for OdBcf::OdBcfComponentVisibility:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfComponentVisibility)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
const OdBcfExceptionsPtr &	getExceptions () const
bool	isExceptionsUnset () const
const bool &	getDefaultVisibility () const
bool	isDefaultVisibilityUnset () 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
OdBcfComponentVisibility &	operator= (const OdBcfComponentVisibilityData &val)

Protected Attributes
friend	OdBcfSession
Protected Attributes inherited from OdBcf::OdBcfComponentVisibilityData
OdBcfExceptionsPtr	m_pExceptions
bool	m_defaultVisibility
friend	OdBcfSession

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 component visibility data.

Definition at line 58 of file BcfComponentVisibility.h.

Member Function Documentation

getDefaultVisibility()

const bool & OdBcf::OdBcfComponentVisibility::getDefaultVisibility

(

)

const

Retrieves whether the default visibility settings are applied.

Returns

A true if the default visibility settings are applied; otherwise, the method returns false.

Remarks

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

getExceptions()

const OdBcfExceptionsPtr & OdBcf::OdBcfComponentVisibility::getExceptions

(

)

const

Retrieves the exceptions for the visibility of components.

Returns

A smart pointer to the <link OdBcf::OdBcfExceptions, OdBcfExceptions> object that represents the version.

Remarks

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

inFields()

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

isDefaultVisibilityUnset()

bool OdBcf::OdBcfComponentVisibility::isDefaultVisibilityUnset

(

)

const

Defines whether the value of the flag that determines if the default visibility settings are applied or not is not initialized.

Returns

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

isExceptionsUnset()

bool OdBcf::OdBcfComponentVisibility::isExceptionsUnset

(

)

const

Defines whether the exceptions object is not initialized.

Returns

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

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfComponentVisibility::ODRX_DECLARE_MEMBERS

(

OdBcfComponentVisibility

)

operator=()

OdBcfComponentVisibility & OdBcf::OdBcfComponentVisibility::operator= ( const OdBcfComponentVisibilityData &  val )

protected

outFields()

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

virtual

Checks whether the component visibility 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::OdBcfComponentVisibility::OdBcfSession

protected

Definition at line 119 of file BcfComponentVisibility.h.

---

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

• BcfComponentVisibility.h