OdDbDynBlockReference Class Reference

#include <DbDynBlockReference.h>

Public Member Functions
	OdDbDynBlockReference (const OdDbObjectId &blockRefId)
	OdDbDynBlockReference (OdDbBlockReference *pRef)
virtual	~OdDbDynBlockReference ()
bool	isDynamicBlock () const
OdDbObjectId	blockId () const
void	getBlockProperties (OdDbDynBlockReferencePropertyArray &properties) const
void	resetBlock ()
bool	convertToStaticBlock ()
bool	convertToStaticBlock (const OdString &newBlockName)
OdDbObjectId	dynamicBlockTableRecord () const
OdDbObjectId	anonymousBlockTableRecord () const

Static Public Member Functions
static bool	isDynamicBlock (const OdDbObjectId &blockTableRecordId)

Friends
class	OdDbDynBlockTableRecord

Detailed Description

This class is a utility class providing access to information on dynamic block references. Corresponding C++ library: TD_DynBlocks <group OdDb_Classes>

Definition at line 182 of file DbDynBlockReference.h.

Constructor & Destructor Documentation

OdDbDynBlockReference() [1/2]

OdDbDynBlockReference::OdDbDynBlockReference

(

const OdDbObjectId &

blockRefId

)

Parameters

blockRefId

[in] Object ID of the dynamic block reference.

OdDbDynBlockReference() [2/2]

OdDbDynBlockReference::OdDbDynBlockReference

(

OdDbBlockReference *

pRef

)

Parameters

pRef	[in] Pointer to the dynamic block reference.

~OdDbDynBlockReference()

virtual OdDbDynBlockReference::~OdDbDynBlockReference ( )

virtual

Member Function Documentation

anonymousBlockTableRecord()

OdDbObjectId OdDbDynBlockReference::anonymousBlockTableRecord

(

)

const

Returns the ObjectID of the anonymous representation block BlockTableRecord used to draw the dynamic block.

blockId()

OdDbObjectId OdDbDynBlockReference::blockId

(

)

const

Returns the Object ID of the block reference.

convertToStaticBlock() [1/2]

bool OdDbDynBlockReference::convertToStaticBlock

(

)

Converts the dynamic block reference to a static block.

Parameters

newBlockName

[in] New block name.

Remarks

If newBlockName is not specified, an anonymous block is created.

convertToStaticBlock() [2/2]

bool OdDbDynBlockReference::convertToStaticBlock

(

const OdString &

newBlockName

)

dynamicBlockTableRecord()

OdDbObjectId OdDbDynBlockReference::dynamicBlockTableRecord

(

)

const

Returns the Object ID of the dynamic block BlockTableRecord.

Returns

Returns NULL if the block reference is not a dynamic block.

getBlockProperties()

void OdDbDynBlockReference::getBlockProperties

(

OdDbDynBlockReferencePropertyArray &

properties

)

const

Returns an array of the dynamic block properties of the block reference.

Parameters

properties

[out] Receives an array of properties.

Remarks

An empty array will be returned if the block reference has no dynamic block properties.

isDynamicBlock() [1/2]

bool OdDbDynBlockReference::isDynamicBlock

(

)

const

Returns true if and only if the specified Block Table Record contains dynamic block information.

Remarks

The Block Reference specified in the constructor will be used.

isDynamicBlock() [2/2]

static bool OdDbDynBlockReference::isDynamicBlock ( const OdDbObjectId &  blockTableRecordId )

static

Returns true if and only if the specified Block Table Record contains dynamic block information.

Parameters

blockTableRecordId

[in] Block Table Record Object ID.

Remarks

If blockTableRecordId is not specified, the Block Reference specified in the constructor will be used.

resetBlock()

void OdDbDynBlockReference::resetBlock

(

)

Resets all properties in the block reference to those of the block definition.

Friends And Related Function Documentation

OdDbDynBlockTableRecord

friend class OdDbDynBlockTableRecord

friend

Definition at line 268 of file DbDynBlockReference.h.

---

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

• DbDynBlockReference.h