CFx SDK Documentation  2022 SP0
Static Public Member Functions | List of all members
OdDbXRefManExt Class Reference

#include <XRefMan.h>

Static Public Member Functions

static OdDbBlockTableRecordPtr addNewXRefDefBlock (OdDbDatabase *pDb, const OdString &pathName, const OdString &blockName, bool overlaid, const OdPassword &password=OdPassword(), OdDbHandle handle=0)
 
static OdDbLayerTableRecordPtr addNewXRefDependentLayer (const OdDbBlockTableRecord *pXRefBlock, const OdString &layerName)
 
static OdDbLayerTableRecordPtr addNewXRefDependentLayer (OdDbObjectId xRefBlockId, const OdString &layerName)
 
static OdDbLinetypeTableRecordPtr addNewXRefDependentLinetype (const OdDbBlockTableRecord *pXRefBlock, const OdString &linetypeName)
 
static OdDbLinetypeTableRecordPtr addNewXRefDependentLinetype (OdDbObjectId xRefBlockId, const OdString &linetypeName)
 
static OdDbTextStyleTableRecordPtr addNewXRefDependentTextStyle (const OdDbBlockTableRecord *pXRefBlock, const OdString &textStyleName)
 
static OdDbTextStyleTableRecordPtr addNewXRefDependentTextStyle (OdDbObjectId xRefBlockId, const OdString &textStyleName)
 
static void addNestedXRefId (OdDbBlockTableRecord *pXRefBlock, OdDbObjectId nestedBlockId)
 
static void getNestedXRefIds (OdDbBlockTableRecord *pXRefBlock, OdDbObjectIdArray &ids)
 
static OdDbObjectId getSymbolTableRecordXrefBlockId (const OdDbSymbolTableRecord *pRec)
 

Detailed Description

This class is the Xref Manager Extenstion class.

Remarks
This class creates and augments Xref blocks in OdDbDatabase instances.

<group OdDb_Classes>

Definition at line 137 of file XRefMan.h.

Member Function Documentation

◆ addNestedXRefId()

static void OdDbXRefManExt::addNestedXRefId ( OdDbBlockTableRecord pXRefBlock,
OdDbObjectId  nestedBlockId 
)
static

Adds nested XRef Id to parent block.

◆ addNewXRefDefBlock()

static OdDbBlockTableRecordPtr OdDbXRefManExt::addNewXRefDefBlock ( OdDbDatabase pDb,
const OdString pathName,
const OdString blockName,
bool  overlaid,
const OdPassword password = OdPassword(),
OdDbHandle  handle = 0 
)
static

Creates an Xref block in the specified database.

Parameters
pDb[in] Pointer to the database.
pathName[in] Path and filename for Xref block.
blockName[in] Name of Xref block.
overlaid[in] True for Xref Overlay, false for Xref Attach.
password[in] Password for file.
handle[in] Handle for Xref block.
Returns
Returns a SmartPointer to the newly added Block Table Record.

◆ addNewXRefDependentLayer() [1/2]

static OdDbLayerTableRecordPtr OdDbXRefManExt::addNewXRefDependentLayer ( const OdDbBlockTableRecord pXRefBlock,
const OdString layerName 
)
static

Adds an Xref dependent layer to the specified Xref block.

Parameters
pXRefBlock[in] Pointer to the Xref Block Table Record.
layerName[in] Name of the layer.
Returns
Returns a SmartPointer to the newly added Layer Table Record.

◆ addNewXRefDependentLayer() [2/2]

static OdDbLayerTableRecordPtr OdDbXRefManExt::addNewXRefDependentLayer ( OdDbObjectId  xRefBlockId,
const OdString layerName 
)
inlinestatic

Adds an Xref dependent layer to the specified Xref block.

Parameters
xRefBlockId[in] Object ID of the Xref Block Table Record.
layerName[in] Name of the layer.
Returns
Returns a SmartPointer to the newly added Layer Table Record.

Definition at line 180 of file XRefMan.h.

◆ addNewXRefDependentLinetype() [1/2]

static OdDbLinetypeTableRecordPtr OdDbXRefManExt::addNewXRefDependentLinetype ( const OdDbBlockTableRecord pXRefBlock,
const OdString linetypeName 
)
static

Adds an Xref dependent linetype to the specified Xref block.

Parameters
pXRefBlock[in] Pointer to the Xref Block Table Record.
linetypeName[in] Name of the linetype.
Returns
Returns a SmartPointer to the newly added Linetype Table Record.

◆ addNewXRefDependentLinetype() [2/2]

static OdDbLinetypeTableRecordPtr OdDbXRefManExt::addNewXRefDependentLinetype ( OdDbObjectId  xRefBlockId,
const OdString linetypeName 
)
inlinestatic

Adds an Xref dependent linetype to the specified Xref block.

Parameters
xRefBlockId[in] Object ID of the Xref Block Table Record.
linetypeName[in] Name of the linetype.
Returns
Returns a SmartPointer to the newly added Linetype Table Record.

Definition at line 205 of file XRefMan.h.

◆ addNewXRefDependentTextStyle() [1/2]

static OdDbTextStyleTableRecordPtr OdDbXRefManExt::addNewXRefDependentTextStyle ( const OdDbBlockTableRecord pXRefBlock,
const OdString textStyleName 
)
static

Adds an Xref dependent text style to the specified Xref block.

Parameters
pXRefBlock[in] Pointer to the Xref Block Table Record.
textStyleName[in] Name of the text style.
Returns
Returns a SmartPointer to the newly added Text Style Table Record.

◆ addNewXRefDependentTextStyle() [2/2]

static OdDbTextStyleTableRecordPtr OdDbXRefManExt::addNewXRefDependentTextStyle ( OdDbObjectId  xRefBlockId,
const OdString textStyleName 
)
inlinestatic

Adds an Xref dependent text style to the specified Xref block.

Parameters
xRefBlockId[in] Object ID of the Xref Block Table Record.
textStyleName[in] Name of the text style.
Returns
Returns a SmartPointer to the newly added Text Style Table Record.

Definition at line 230 of file XRefMan.h.

◆ getNestedXRefIds()

static void OdDbXRefManExt::getNestedXRefIds ( OdDbBlockTableRecord pXRefBlock,
OdDbObjectIdArray ids 
)
static

Gets nested XRef Ids.

◆ getSymbolTableRecordXrefBlockId()

static OdDbObjectId OdDbXRefManExt::getSymbolTableRecordXrefBlockId ( const OdDbSymbolTableRecord pRec)
static

Gets block Id for a table record.


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