CFx SDK Documentation  2023 SP0
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfPoint Class Reference

#include <BcfPoint.h>

Inheritance diagram for OdBcf::OdBcfPoint:
OdBcf::OdBcfElement OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfPoint)
 
 OdBcfPoint ()
 
virtual OdResult inFields (TiXmlElement *pParent) ODRX_OVERRIDE
 
virtual OdResult outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
 
virtual bool validate () const ODRX_OVERRIDE
 
 DECLARE_CONST_ACCESSORS (X, double, m_x)
 
 DECLARE_CONST_ACCESSORS (Y, double, m_y)
 
 DECLARE_CONST_ACCESSORS (Z, double, m_z)
 
- 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
 

Static Public Member Functions

static OdSmartPtr< OdBcfPointcreateObject (double x, double y, double z)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Attributes

double m_x
 
double m_y
 
double m_z
 

Detailed Description

A class that contains Point data type.

Definition at line 39 of file BcfPoint.h.

Constructor & Destructor Documentation

◆ OdBcfPoint()

OdBcf::OdBcfPoint::OdBcfPoint ( )

Creates a new object with default parameters.

Member Function Documentation

◆ createObject()

static OdSmartPtr<OdBcfPoint> OdBcf::OdBcfPoint::createObject ( double  x,
double  y,
double  z 
)
static

Creates a new point object.

Parameters
x[in] A x position of point.
y[in] A y position of point.
z[in] A z position of point.
Returns
Returns a smart pointer to the created <link OdBcf::OdBcfPoint, OdBcfPoint> instance.

◆ DECLARE_CONST_ACCESSORS() [1/3]

OdBcf::OdBcfPoint::DECLARE_CONST_ACCESSORS ( X  ,
double  ,
m_x   
)

◆ DECLARE_CONST_ACCESSORS() [2/3]

OdBcf::OdBcfPoint::DECLARE_CONST_ACCESSORS ( Y  ,
double  ,
m_y   
)

◆ DECLARE_CONST_ACCESSORS() [3/3]

OdBcf::OdBcfPoint::DECLARE_CONST_ACCESSORS ( Z  ,
double  ,
m_z   
)

◆ inFields()

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

◆ outFields()

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

double OdBcf::OdBcfPoint::m_x
protected

Definition at line 87 of file BcfPoint.h.

◆ m_y

double OdBcf::OdBcfPoint::m_y
protected

Definition at line 88 of file BcfPoint.h.

◆ m_z

double OdBcf::OdBcfPoint::m_z
protected

Definition at line 89 of file BcfPoint.h.


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