OdDbSubentId Class Reference

#include <DbBaseSubentId.h>

Public Member Functions
	OdDbSubentId ()
	OdDbSubentId (OdDb::SubentType type, OdGsMarker index)
bool	operator== (const OdDbSubentId &subentId) const
bool	operator!= (const OdDbSubentId &subentId) const
OdDb::SubentType	type () const
void	setType (OdDb::SubentType type)
OdGsMarker	index () const
void	setIndex (OdGsMarker index)

Detailed Description

This class implements Subentity Id objects for OdDbEntity objects in an OdDbDatabase instance.

Remarks

A given OdDbEntity object may consist of any number of graphical subentities.

Subentity type must be one of the following:

Value OdDb::kNullSubentType 0 OdDb::kFaceSubentType 1 OdDb::kEdgeSubentType 2 OdDb::kVertexSubentType 3
OdDb::kMlineSubentCache 4

Each SubentityId object is created from a Subentity type and an index.

Corresponding C++ library: TD_DbRoot

<group OdDbRoot_Classes>

Definition at line 75 of file DbBaseSubentId.h.

Constructor & Destructor Documentation

OdDbSubentId() [1/2]

OdDbSubentId::OdDbSubentId ( )

inline

Default constructor for objects of the OdDbSubentId class. Constructs a subentity of the kNullSubentType type and index equal to 0.

Definition at line 83 of file DbBaseSubentId.h.

OdDbSubentId() [2/2]

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

inline

Constructor for objects of the OdDbSubentId class.

Parameters

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

Definition at line 94 of file DbBaseSubentId.h.

Member Function Documentation

index()

OdGsMarker OdDbSubentId::index ( ) const

inline

Returns the index of this SubentId object.

Returns

Index of this SubentId object.

Definition at line 174 of file DbBaseSubentId.h.

operator!=()

bool OdDbSubentId::operator!= ( const OdDbSubentId &  subentId ) const

inline

Comparison operator "not equal". This operator compares this object with another object of the OdDbSubentId type.

Parameters

subentId

[in] Object to be compared with this object.

Returns

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

Definition at line 120 of file DbBaseSubentId.h.

operator==()

bool OdDbSubentId::operator== ( const OdDbSubentId &  subentId ) const

inline

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

Parameters

subentId

[in] Object to be compared with this object.

Returns

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

Definition at line 107 of file DbBaseSubentId.h.

setIndex()

void OdDbSubentId::setIndex ( OdGsMarker  index )

inline

Sets the index of this SubentId object.

Parameters

index

[in] Index.

Definition at line 184 of file DbBaseSubentId.h.

setType()

void OdDbSubentId::setType ( OdDb::SubentType  type )

inline

Sets the type of this SubentId object.

Parameters

type	[in] Subentity type.

Remarks

Subentity type must be one of the following:

Value OdDb::kNullSubentType 0 OdDb::kFaceSubentType 1 OdDb::kEdgeSubentType 2 OdDb::kVertexSubentType 3
OdDb::kMlineSubentCache 4

Definition at line 164 of file DbBaseSubentId.h.

type()

OdDb::SubentType OdDbSubentId::type ( ) const

inline

Returns the type of this SubentId object.

Returns

Type of this SubentId object.

Remarks

The return value can be one of the following:

Value OdDb::kNullSubentType 0 OdDb::kFaceSubentType 1 OdDb::kEdgeSubentType 2 OdDb::kVertexSubentType 3
OdDb::kMlineSubentCache 4

Definition at line 142 of file DbBaseSubentId.h.

---

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

• DbBaseSubentId.h