OdDbSubentRef Class Reference

#include <DbGeomRef.h>

Inheritance diagram for OdDbSubentRef:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbSubentRef)
	OdDbSubentRef ()
	OdDbSubentRef (const OdDbCompoundObjectId &compId, const OdDbSubentId &subent=OdDbSubentId())
OdDbSubentRef &	operator= (const OdDbSubentRef &src)
virtual void	copyFrom (const OdRxObject *src)
virtual void	reset ()
virtual bool	isValid () const
virtual bool	isEmpty () const
virtual const OdDbCompoundObjectId &	entity () const
virtual OdDbSubentId	subentId () const
virtual OdDbEntityPtr	createEntity () const
virtual OdResult	evaluateAndCacheGeometry ()
Public Member Functions inherited from OdDbGeomRef
	ODRX_DECLARE_MEMBERS (OdDbGeomRef)
virtual	~OdDbGeomRef ()
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 OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdSmartPtr< OdDbSubentRef >	createObject (const OdDbCompoundObjectId &compId, const OdDbSubentId &subent=OdDbSubentId())
static OdSmartPtr< OdDbSubentRef >	createObject (const OdDbCompoundObjectId *pid, const OdDbSubentId &subentid=OdDbSubentId())
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Protected Member Functions
void	setEntity (const OdDbCompoundObjectId &entityId)
void	setSubent (const OdDbSubentId &subentId)
void	setFromSubentPath (const OdDbFullSubentPath &pathSubEnt)

Detailed Description

This class represents a reference to a subent object.

<group OdDb_Classes>

Definition at line 105 of file DbGeomRef.h.

Constructor & Destructor Documentation

OdDbSubentRef() [1/2]

OdDbSubentRef::OdDbSubentRef

(

)

Constructor creates an instance of this class.

OdDbSubentRef() [2/2]

OdDbSubentRef::OdDbSubentRef	(	const OdDbCompoundObjectId &	compId,
		const OdDbSubentId &	subent = OdDbSubentId() )

Creates an instance of this class.

Parameters

compId	[in] input component id
subent	[in] input subentity id

Member Function Documentation

copyFrom()

virtual void OdDbSubentRef::copyFrom ( const OdRxObject * src )

virtual

Creates OdDbSubentRef using other OdDbSubentRef.

Parameters

src	[in] subentity reference that will be copied

Reimplemented from OdRxObject.

Reimplemented in OdDbEdgeRef, OdDbFaceRef, and OdDbVertexRef.

createEntity()

virtual OdDbEntityPtr OdDbSubentRef::createEntity ( ) const

virtual

Creates an entity using this subent reference.

Returns

created entity.

Remarks

This method is not implemented.

Reimplemented from OdDbGeomRef.

Reimplemented in OdDbEdgeRef, OdDbFaceRef, and OdDbVertexRef.

createObject() [1/2]

static OdSmartPtr< OdDbSubentRef > OdDbSubentRef::createObject ( const OdDbCompoundObjectId & compId, const OdDbSubentId & subent = OdDbSubentId() )

static

Creates an instance of this class.

Parameters

compId	[in] input component id
subent	[in] input subentity id

createObject() [2/2]

static OdSmartPtr< OdDbSubentRef > OdDbSubentRef::createObject ( const OdDbCompoundObjectId * pid, const OdDbSubentId & subentid = OdDbSubentId() )

inlinestatic

Deprecated.

Definition at line 136 of file DbGeomRef.h.

entity()

virtual const OdDbCompoundObjectId & OdDbSubentRef::entity ( ) const

virtual

Returns an object ID of the compounded entity.

Reimplemented in OdDbVertexRef.

evaluateAndCacheGeometry()

virtual OdResult OdDbSubentRef::evaluateAndCacheGeometry ( )

virtual

Evaluates and caches the geometry.

Returns

eOk if geometry is evaluated cached.

Reimplemented from OdDbGeomRef.

Reimplemented in OdDbEdgeRef, OdDbFaceRef, and OdDbVertexRef.

isEmpty()

virtual bool OdDbSubentRef::isEmpty ( ) const

virtual

Checks whether this subent reference is empty.

Returns

true if subent reference is empty.

Reimplemented from OdDbGeomRef.

Reimplemented in OdDbEdgeRef, and OdDbFaceRef.

isValid()

virtual bool OdDbSubentRef::isValid ( ) const

virtual

Checks whether this subent reference is valid.

Returns

true if subent reference is valid.

Reimplemented from OdDbGeomRef.

Reimplemented in OdDbEdgeRef, OdDbFaceRef, and OdDbVertexRef.

ODRX_DECLARE_MEMBERS()

OdDbSubentRef::ODRX_DECLARE_MEMBERS

(

OdDbSubentRef

)

operator=()

OdDbSubentRef & OdDbSubentRef::operator=

(

const OdDbSubentRef &

src

)

Creates OdDbSubentRef using other OdDbSubentRef.

Parameters

src	[in] subentity reference that will be copied

reset()

virtual void OdDbSubentRef::reset ( )

virtual

Resets this subent reference.

Reimplemented from OdDbGeomRef.

Reimplemented in OdDbEdgeRef, OdDbFaceRef, and OdDbVertexRef.

setEntity()

void OdDbSubentRef::setEntity ( const OdDbCompoundObjectId & entityId )

protected

Sets the compounded entity using an object ID.

Parameters

entityId

[in] the object ID.

setFromSubentPath()

void OdDbSubentRef::setFromSubentPath ( const OdDbFullSubentPath & pathSubEnt )

protected

Sets an subent ID using the full subent path.

Parameters

pathSubEnt

[in] the full subent path.

setSubent()

void OdDbSubentRef::setSubent ( const OdDbSubentId & subentId )

protected

Sets an subent ID.

subentId()

virtual OdDbSubentId OdDbSubentRef::subentId ( ) const

virtual

Returns an subent ID.

Reimplemented in OdDbVertexRef.

---

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

• DbGeomRef.h