OdDbBaseFullSubentPath Class Reference

#include <DbBaseSubentId.h>

Inheritance diagram for OdDbBaseFullSubentPath:

Public Member Functions
	OdDbBaseFullSubentPath ()
	OdDbBaseFullSubentPath (OdDb::SubentType type, OdGsMarker index)
	OdDbBaseFullSubentPath (OdDbStub *entId, OdDbSubentId subId)
	OdDbBaseFullSubentPath (OdDbStub *entId, OdDb::SubentType type, OdGsMarker index)
	OdDbBaseFullSubentPath (OdDbStubPtrArray objectIds, OdDbSubentId subId)
void	objectIds (OdDbStubPtrArray &objectIdsArg) const
OdDbBaseFullSubentPath &	operator= (const OdDbBaseFullSubentPath &fullSubentPath)
bool	operator== (const OdDbBaseFullSubentPath &fullSubentPath) const
const OdDbStubPtrArray &	objectIds () const
OdDbStubPtrArray &	objectIds ()
const OdDbSubentId	subentId () const
OdDbSubentId &	subentId ()

Protected Attributes
OdDbStubPtrArray	m_ObjectIds
OdDbSubentId	m_SubentId

Detailed Description

This base class uniquely defines subentities within in a database instance.

Remarks

Each OdDbBaseFullSubentPath object consists of a OdDbSubentId object and an ordered array of Object IDs. The SubentId consists the index and subentType of the object. The array of Object IDs defines the path to the subentity from the outermost entity to the entity containing the subentity.

Corresponding C++ library: TD_DbRoot

<group OdDbRoot_Classes>

Definition at line 251 of file DbBaseSubentId.h.

Constructor & Destructor Documentation

OdDbBaseFullSubentPath() [1/5]

OdDbBaseFullSubentPath::OdDbBaseFullSubentPath ( )

inline

Default constructor for objects of the OdDbBaseFullSubentPath class.

Definition at line 258 of file DbBaseSubentId.h.

OdDbBaseFullSubentPath() [2/5]

OdDbBaseFullSubentPath::OdDbBaseFullSubentPath ( OdDb::SubentType type, OdGsMarker index )

inline

Constructor for objects of the OdDbBaseFullSubentPath class. Constructs a subentity based on type and index.

Parameters

type	[in] Subentity type.
index	[in] Index.

Definition at line 268 of file DbBaseSubentId.h.

OdDbBaseFullSubentPath() [3/5]

OdDbBaseFullSubentPath::OdDbBaseFullSubentPath ( OdDbStub * entId, OdDbSubentId subId )

inline

Constructor for objects of the OdDbBaseFullSubentPath class.

Parameters

entId	[in] Object ID.
subId	[in] Subentity ID.

Definition at line 278 of file DbBaseSubentId.h.

OdDbBaseFullSubentPath() [4/5]

OdDbBaseFullSubentPath::OdDbBaseFullSubentPath ( OdDbStub * entId, OdDb::SubentType type, OdGsMarker index )

inline

Constructor for objects of the OdDbBaseFullSubentPath class. Constructs a subentity based on type and index.

Parameters

entId	[in] Object ID.
type	[in] Subentity type.
index	[in] Index.

Definition at line 293 of file DbBaseSubentId.h.

OdDbBaseFullSubentPath() [5/5]

OdDbBaseFullSubentPath::OdDbBaseFullSubentPath ( OdDbStubPtrArray objectIds, OdDbSubentId subId )

inline

Constructor for objects of the OdDbBaseFullSubentPath class.

Parameters

objectIds	[in] Array of object IDs.
subId	[in] Subentity ID.

Definition at line 306 of file DbBaseSubentId.h.

Member Function Documentation

objectIds() [1/3]

OdDbStubPtrArray & OdDbBaseFullSubentPath::objectIds ( )

inline

Returns a reference to the embedded OdDbStubPtrArray object in this BaseFullSubentPath object.

Returns

Reference to the OdDbStubPtrArray object.

Definition at line 366 of file DbBaseSubentId.h.

objectIds() [2/3]

const OdDbStubPtrArray & OdDbBaseFullSubentPath::objectIds ( ) const

inline

Returns a reference to the embedded OdDbStubPtrArray object in this BaseFullSubentPath object.

Returns

Reference to the OdDbStubPtrArray object.

Definition at line 356 of file DbBaseSubentId.h.

objectIds() [3/3]

void OdDbBaseFullSubentPath::objectIds ( OdDbStubPtrArray & objectIdsArg ) const

inline

Returns the array of object IDs that define the path to the subentity.

Parameters

objectIdsArg

[out] Array of object IDs.

Definition at line 317 of file DbBaseSubentId.h.

operator=()

OdDbBaseFullSubentPath & OdDbBaseFullSubentPath::operator= ( const OdDbBaseFullSubentPath & fullSubentPath )

inline

This is the assignment operator for objects of the OdDbBaseFullSubentPath class. Assigns the value of the second operand to the first one.

Parameters

fullSubentPath

[in] Object to be assigned.

Returns

A reference to this OdDbBaseFullSubentPath object.

Definition at line 331 of file DbBaseSubentId.h.

operator==()

bool OdDbBaseFullSubentPath::operator== ( const OdDbBaseFullSubentPath & fullSubentPath ) const

inline

Comparison operator. This operator compares this object with another object of the OdDbBaseFullSubentPath type.

Parameters

fullSubentPath

[in] Object to be compared with this object.

Returns

True if the objects are equal to each other; false otherwise.

Definition at line 346 of file DbBaseSubentId.h.

subentId() [1/2]

OdDbSubentId & OdDbBaseFullSubentPath::subentId ( )

inline

Returns a reference to the embedded OdDbSubentId object in this BaseFullSubentPath object.

Returns

Reference to the OdDbSubentId object.

Definition at line 386 of file DbBaseSubentId.h.

subentId() [2/2]

const OdDbSubentId OdDbBaseFullSubentPath::subentId ( ) const

inline

Returns a copy of the embedded OdDbSubentId object in this BaseFullSubentPath object.

Returns

Copy of the embedded OdDbSubentId object.

Definition at line 376 of file DbBaseSubentId.h.

Member Data Documentation

m_ObjectIds

OdDbStubPtrArray OdDbBaseFullSubentPath::m_ObjectIds

protected

Definition at line 392 of file DbBaseSubentId.h.

m_SubentId

OdDbSubentId OdDbBaseFullSubentPath::m_SubentId

protected

Definition at line 393 of file DbBaseSubentId.h.

---

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

• DbBaseSubentId.h