CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfViewPoint Class Reference

#include <BcfViewpoint.h>

Inheritance diagram for OdBcf::OdBcfViewPoint:
OdBcf::OdBcfElement OdBcf::OdBcfViewPointData OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfViewPoint)
 
 OdBcfViewPoint ()
 
virtual OdResult inFields (TiXmlElement *pParent) ODRX_OVERRIDE
 
virtual OdResult outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
 
virtual bool validate () const ODRX_OVERRIDE
 
 DECLARE_CONST_ACCESSORS (Viewpoint, OdString, m_viewpoint)
 
 DECLARE_CONST_ACCESSORS (Snapshot, OdString, m_snapshot)
 
 DECLARE_CONST_ACCESSORS (Index, OdInt32, m_index)
 
 DECLARE_CONST_ACCESSORS (Guid, OdGUID, m_guid)
 
- Public Member Functions inherited from OdBcf::OdBcfElement
 ODRX_DECLARE_MEMBERS (OdBcfElement)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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

OdBcfViewPointoperator= (const OdBcfViewPointData &val)
 

Protected Attributes

friend OdBcfSession
 
- Protected Attributes inherited from OdBcf::OdBcfViewPointData
OdString m_viewpoint
 
OdString m_snapshot
 
OdInt32 m_index
 
OdGUID m_guid
 
friend OdBcfSession
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

A class that contains ViewPoint data type.

Definition at line 56 of file BcfViewpoint.h.

Constructor & Destructor Documentation

◆ OdBcfViewPoint()

OdBcf::OdBcfViewPoint::OdBcfViewPoint ( )

Creates a new object with default parameters.

Member Function Documentation

◆ DECLARE_CONST_ACCESSORS() [1/4]

OdBcf::OdBcfViewPoint::DECLARE_CONST_ACCESSORS ( Guid  ,
OdGUID  ,
m_guid   
)

◆ DECLARE_CONST_ACCESSORS() [2/4]

OdBcf::OdBcfViewPoint::DECLARE_CONST_ACCESSORS ( Index  ,
OdInt32  ,
m_index   
)

◆ DECLARE_CONST_ACCESSORS() [3/4]

OdBcf::OdBcfViewPoint::DECLARE_CONST_ACCESSORS ( Snapshot  ,
OdString  ,
m_snapshot   
)

◆ DECLARE_CONST_ACCESSORS() [4/4]

OdBcf::OdBcfViewPoint::DECLARE_CONST_ACCESSORS ( Viewpoint  ,
OdString  ,
m_viewpoint   
)

◆ inFields()

virtual OdResult OdBcf::OdBcfViewPoint::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::OdBcfViewPoint::ODRX_DECLARE_MEMBERS ( OdBcfViewPoint  )

◆ operator=()

OdBcfViewPoint& OdBcf::OdBcfViewPoint::operator= ( const OdBcfViewPointData val)
protected

◆ outFields()

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

◆ OdBcfSession

friend OdBcf::OdBcfViewPoint::OdBcfSession
protected

Definition at line 98 of file BcfViewpoint.h.


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