#include <DbBlockPropertiesTable.h>

Inheritance diagram for OdDbBlockPropertiesTable:

Public Member Functions
	ODDB_EVAL_DECLARE_MEMBERS (OdDbBlockPropertiesTable)

	OdDbBlockPropertiesTable ()

int	numberOfColumns () const

int	numberOfRows () const

OdResult	getCellValue (int column, int row, OdResBufPtr &rb) const

OdResult	setCellValue (int column, int row, const OdResBuf *rb)

OdResult	getCellValueString (int column, int row, OdString &s) const

bool	constant (int column) const

OdResult	setConstant (int column, bool val)

bool	editable (int column) const

OdResult	setEditable (int column, bool val)

bool	removable (int column) const

OdResult	setRemovable (int column, bool val)

bool	isAngular (int column) const

bool	isAttribute (int) const

OdDbObjectId	customProperties (int column) const

void	setCustomProperties (int column, const OdDbObjectId &id)

OdResBufPtr	defaultValue (int column) const

void	setDefaultValue (int column, const OdResBuf *rb)

OdString	format (int column) const

void	setFormat (int column, const OdString &f)

bool	mustMatch () const

void	setMustMatch (bool b)

void	setUnmatchedValue (int column, const OdResBuf *rb)

OdResBufPtr	unmatchedValue (int column) const

OdString	getColumnName (int column) const

OdString	GetName (OdInt32 iColumn) const

OdInt32	GetColumnCount () const

OdInt32	GetRowCount () const

const OdInt32Array &	GetRowIndices () const

const OdDbObjectId &	GetParameterId (OdInt32 iColumn) const

const OdResBufPtr	GetValue (OdInt32 iColumn, OdInt32 iRow) const

OdString	tableDescription () const

void	setTableDescription (const OdString &s)

OdString	tableName () const

void	setTableName (const OdString &s)

int	idOfRow (int index) const

int	indexOfRow (int id) const

void	insertColumn (const OdDbObjectId &param, const OdString &connection, int after)

void	insertRow (int after)

void	removeColumn (int column)

void	removeRow (int row)

void	appendColumn (const OdDbObjectId &param, const OdString &connection)

void	appendRow ()

void	moveColumn (int from, int to)

void	moveRow (int from, int to)

virtual void	addedToGraph (OdDbEvalGraph *) ODRX_OVERRIDE

virtual void	erased (const OdDbObject *, bool) ODRX_OVERRIDE

virtual void	removedFromGraph (OdDbEvalGraph *gr) ODRX_OVERRIDE

int	getDefaultActiveRow () const

void	setDefaultActiveRow (int row)

bool	columnValuesAreUnique (int col) const

bool	disabledInDrawingEditor () const

bool	runtimeParametersOnly () const

void	setRuntimeParametersOnly (bool b)

void	tableAudit (OdArray< OdDbBPTAuditError > &)

void	sortRows (int column, bool ascending)

Public Member Functions inherited from OdDbBlock1PtParameter
	ODDB_EVAL_DECLARE_MEMBERS (OdDbBlock1PtParameter)

OdDbBlockGripPtr	getAssociatedGrip (OdDb::OpenMode)

virtual void	graphEvalEnd (bool)

OdGePoint3d	definitionPoint () const

void	setDefinitionPoint (const OdGePoint3d &)

OdGePoint3d	point ()

void	setPoint (const OdGePoint3d &)

OdGePoint3d	updatedPoint ()

void	setUpdatedPoint (const OdGePoint3d &)

Public Member Functions inherited from OdDbBlockParameter
	ODDB_EVAL_DECLARE_MEMBERS (OdDbBlockParameter)

virtual OdString	getPropertyConnectionName (const OdString &) const

virtual void	getPropertyDescription (OdDbBlkParamPropertyDescriptorArray &) const

virtual OdResBufPtr	getPropertyValue (const OdString &) const

virtual OdResBufPtr	getPropertyValue (const OdString &, const OdGeMatrix3d &) const

virtual ParameterComponent	getComponentForGrip (OdDbEvalNodeId)

virtual bool	setPropertyValue (const OdString &, const OdResBuf *)

virtual bool	setPropertyValue (const OdString &, const OdGeMatrix3d &, const OdResBuf *)

virtual bool	chainActions () const

virtual void	setChainActions (bool)

virtual bool	showProperties () const

virtual void	setShowProperties (bool)

OdDbEvalNodeId	addGrip (ParameterComponent)

Public Member Functions inherited from OdDbBlockElement
	ODDB_EVAL_DECLARE_MEMBERS (OdDbBlockElement)

virtual bool	evaluate (const OdDbEvalContext *)

virtual bool	connectionAllowed (const OdString &, OdDbEvalNodeId, const OdString &) const
	DOM OdDbEvalConnectable interface.

virtual bool	connectTo (const OdString &, OdDbEvalNodeId, const OdString &)

virtual bool	disconnectFrom (const OdString &, OdDbEvalNodeId, const OdString &)

virtual bool	hasConnectionNamed (const OdString &) const

virtual bool	getConnectedNames (const OdString &, unsigned long, OdStringArray &) const

virtual bool	getConnectedObjects (const OdString &, OdDbEvalNodeIdArray &) const

virtual void	getConnectionNames (OdStringArray &) const

virtual bool	getConnectionType (const OdString &name, OdResBuf::ValueType &type) const

virtual OdResBufPtr	getConnectionValue (const OdString &name) const

virtual OdString	name () const
	DOM

virtual void	setName (const OdString &)

virtual OdDb::MaintReleaseVer	getInstanceMaintenanceVersion ()

virtual OdDb::DwgVersion	getInstanceVersion ()

virtual void	getStretchPoints (OdGePoint3dArray &) const

virtual void	moveStretchPointsAt (const OdIntArray &, const OdGeVector3d &)

virtual HistoryCompression	historyCompression () const

virtual bool	historyRequired () const

virtual bool	hasInstanceData () const
	DOM static bool isNameUnique(class OdDbEvalGraph* graph, const OdString& name, OdString* result );.

virtual bool	loadInstanceData (const OdResBuf *, bool bRequireEvaluate=false)

virtual OdResBufPtr	saveInstanceData () const

virtual void	updateConnections ()

virtual bool	isMemberOfCurrentVisibilitySet () const

virtual void	setMemberOfCurrentVisibilitySet (bool)

virtual OdResult	transformBy (const OdGeMatrix3d &)

Public Member Functions inherited from OdDbEvalConnectable
	ODDB_DECLARE_MEMBERS (OdDbEvalConnectable)

virtual	~OdDbEvalConnectable ()

virtual void	getConnectionNames (OdStringArray &connectionNames) const

virtual bool	hasConnectionNamed (const OdString &connectionName) const

virtual bool	getConnectionType (const OdString &connectionName, OdResBuf::ValueType &connectionType) const

virtual OdResBufPtr	getConnectionValue (const OdString &connectionName) const

virtual bool	setConnectionValue (const OdString &connectionName, const OdResBuf *pValue)

virtual bool	connectTo (const OdString &thisConnectionName, OdDbEvalNodeId sourceConnectableId, const OdString &sourceConnectionName)

virtual bool	disconnectFrom (const OdString &thisConnectionName, OdDbEvalNodeId sourceConnectableId, const OdString &sourceConnectionName)

virtual bool	connectionAllowed (const OdString &thisConnectionName, OdDbEvalNodeId sourceConnectableId, const OdString &sourceConnectionName) const

virtual bool	getConnectedObjects (const OdString &thisConnectionName, OdDbEvalNodeIdArray &connectedObjects) const

virtual bool	getConnectedNames (const OdString &thisConnectionName, OdDbEvalNodeId sourceConnectableId, OdStringArray &sourceConnectionNames) const

Public Member Functions inherited from OdDbEvalExpr
	ODDB_DECLARE_MEMBERS (OdDbEvalExpr)

	OdDbEvalExpr ()

virtual	~OdDbEvalExpr ()

OdDbEvalGraphPtr	getGraph (OdDb::OpenMode openMode=OdDb::kForRead) const

OdDbEvalNodeId	nodeId () const

virtual void	addedToGraph (OdDbEvalGraph *pGraph)

virtual void	removedFromGraph (OdDbEvalGraph *pGraph)

virtual void	adjacentNodeRemoved (const OdDbEvalNodeId &adjNodeId)

virtual void	adjacentEdgeRemoved (const OdDbEvalNodeId &adjEdgeNodeId)

virtual void	adjacentEdgeAdded (const OdDbEvalNodeId &fromId, const OdDbEvalNodeId &toId, bool isInvertible)

virtual void	movedFromGraph (OdDbEvalGraph *pFromGraph)

virtual void	movedIntoGraph (OdDbEvalGraph *pIntoGraph)

virtual void	copiedIntoGraph (OdDbEvalGraph *pIntoGraph)

virtual bool	isActivatable () const

virtual void	activated (OdDbEvalNodeIdArray &argumentActiveList)

virtual void	graphEvalStart (bool nodeIsActive)

virtual void	graphEvalEnd (bool nodeIsActive)

virtual void	graphEvalAbort (bool nodeIsActive)

virtual bool	evaluate (const OdDbEvalContext *evalContext)

virtual bool	equals (const OdDbEvalExpr *pOther) const

OdResBufPtr	value () const

virtual void	remappedNodeIds (OdDbEvalIdMap &idMap)

OdResult	dwgInFields (OdDbDwgFiler *pFiler)

void	dwgOutFields (OdDbDwgFiler *pFiler) const

OdResult	dxfInFields (OdDbDxfFiler *pFiler)

void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	postInDatabase (OdDbDatabase *)

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

void	addRef ()

void	release ()

long	numRefs () const

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual OdResult	subOpen (OdDb::OpenMode mode)

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual bool	isPersistent () const =0

virtual OdDbStub *	id () const =0

virtual void	setGsNode (OdGsCache *pGsNode)=0

virtual OdGsCache *	gsNode () const =0

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

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 void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdDbEvalNodeId	bptNodeId (const OdDbEvalGraph *gr)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Additional Inherited Members
Public Types inherited from OdDbBlockParameter
enum	ParameterComponent { Base , End , BaseXEndY , EndXBaseY , InvalidComponent }

Public Types inherited from OdDbBlockElement
enum	HistoryCompression { kHistoryCompression0 , kHistoryCompression1 , kHistoryCompression2 , kHistoryCompression3 }

Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 , kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 , kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 , kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 , kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff }

enum	DrawableType { kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 , kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground , kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground , kImageBasedLightingBackground }

Protected Member Functions inherited from OdDbEvalConnectable
	OdDbEvalConnectable ()

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const =0

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const =0

virtual void	subViewportDraw (OdGiViewportDraw *vd) const =0

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Protected Attributes inherited from OdDbEvalExpr
OdResBufPtr	m_lastValue

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 191 of file DbBlockPropertiesTable.h.

Constructor & Destructor Documentation

◆ OdDbBlockPropertiesTable()

OdDbBlockPropertiesTable::OdDbBlockPropertiesTable ( )

Creates a new instance of an OdDbBlockPropertiesTable object with default parameters.

Member Function Documentation

◆ addedToGraph()

virtual void OdDbBlockPropertiesTable::addedToGraph ( OdDbEvalGraph * pGraph )

virtual

Notification function called whenever this Node object has been added to a Graph object.

Parameters

pGraph [in] Pointer to the Graph object.

Remarks: Called by OdDbEvalGraph::addNode().

This function is called after the operation.

Reimplemented from OdDbEvalExpr.

◆ appendColumn()

void OdDbBlockPropertiesTable::appendColumn	(	const OdDbObjectId &	param,
		const OdString &	connection
	)

Appends the column.

Parameters

param	[in] ID of the column.
connection	[in] Connection for the column.

◆ appendRow()

void OdDbBlockPropertiesTable::appendRow ( )

Appends the row.

◆ bptNodeId()

static OdDbEvalNodeId OdDbBlockPropertiesTable::bptNodeId ( const OdDbEvalGraph * gr )

static

Gets the node ID of a block properties table.

Parameters

gr	[in] Eval graph.

Returns: The block properties table node ID.

Remarks: The block properties table node ID is stored in the eval graph xdata, and reactors keep it updated.

◆ columnValuesAreUnique()

bool OdDbBlockPropertiesTable::columnValuesAreUnique ( int col ) const

Checks whether the column values are unique.

Parameters

col	[in] Column index.

Returns: The true value if the column values are unique, or false otherwise.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ constant()

bool OdDbBlockPropertiesTable::constant ( int column ) const

Checks whether the specified column is constant.

Parameters

column [in] Column index.

Returns: The true value if the specified column is constant, or false otherwise.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ customProperties()

OdDbObjectId OdDbBlockPropertiesTable::customProperties ( int column ) const

Gets the ID of the custom properties.

Parameters

column [in] Column index.

Returns: The ID of the custom properties.

Remarks: The ID of the custom properties is optional. The default value is NULL. Throws the eInvalidIndex exception if the column index is not valid.

◆ defaultValue()

OdResBufPtr OdDbBlockPropertiesTable::defaultValue ( int column ) const

Gets the default value of the specified column.

Parameters

column [in] Column index.

Returns: Pointer to the default value of the specified column as an OdResBufPtr object.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ disabledInDrawingEditor()

bool OdDbBlockPropertiesTable::disabledInDrawingEditor ( ) const

Not implemented.

Returns: The false value.

◆ editable()

bool OdDbBlockPropertiesTable::editable ( int column ) const

Checks whether the specified column is editable.

Parameters

column [in] Column index.

Returns: The true value if the specified column is editable, or false otherwise.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ erased()

virtual void OdDbBlockPropertiesTable::erased	(	const OdDbObject *	pObject,
		bool	erasing
	)

virtual

Notification function called whenever an object has been erased or unerased.

Parameters

pObject	[in] Pointer to the object that was erased/unerased.
erasing	[in] True if and only if this object is being erased.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ format()

OdString OdDbBlockPropertiesTable::format ( int column ) const

Gets the format of the specified column.

Parameters

column [in] Column index.

Returns: Format of the specified column as an OdString object.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ getCellValue()

OdResult OdDbBlockPropertiesTable::getCellValue	(	int	column,
		int	row,
		OdResBufPtr &	rb
	)		const

Returns the value of the specified cell.

Parameters

column	[in] Column index.
row	[in] Row index.
rb	[out] Receives a copy of the cell value.

Returns: Returns eOk if the indices are valid, or eInvalidIndex otherwise.

◆ getCellValueString()

OdResult OdDbBlockPropertiesTable::getCellValueString	(	int	column,
		int	row,
		OdString &	s
	)		const

Returns the value of the specified cell as an OdString value.

Parameters

column	[in] Column index.
row	[in] Row index.
s	[out] Receives a copy of the cell value as an OdString value.

Returns: Returns eOk if the indices are valid, or eInvalidIndex otherwise.

◆ GetColumnCount()

OdInt32 OdDbBlockPropertiesTable::GetColumnCount ( ) const

◆ getColumnName()

OdString OdDbBlockPropertiesTable::getColumnName ( int column ) const

Gets the name of the column.

Parameters

column [in] Column index.

Returns: The name of the column.

Remarks: Throws the eInvalidIndex exception if the column index is not valid. Returns OdString::kEmpty if the object specified with the column is NULL or if the object does not belong to any of these types: OdDbBlockUserParameter OdDbBlockParameter OdDbAttributeDefinition OdDbAttributeDefinitionPtr

◆ getDefaultActiveRow()

int OdDbBlockPropertiesTable::getDefaultActiveRow ( ) const

Looks for a row that matches the default parameter values.

Returns: -1

Remarks: Always returns -1.

◆ GetName()

OdString OdDbBlockPropertiesTable::GetName ( OdInt32 iColumn ) const

◆ GetParameterId()

const OdDbObjectId & OdDbBlockPropertiesTable::GetParameterId ( OdInt32 iColumn ) const

◆ GetRowCount()

OdInt32 OdDbBlockPropertiesTable::GetRowCount ( ) const

◆ GetRowIndices()

const OdInt32Array & OdDbBlockPropertiesTable::GetRowIndices ( ) const

◆ GetValue()

const OdResBufPtr OdDbBlockPropertiesTable::GetValue	(	OdInt32	iColumn,
		OdInt32	iRow
	)		const

◆ idOfRow()

int OdDbBlockPropertiesTable::idOfRow ( int index ) const

Gets the ID of the specified row.

Parameters

index [in] Row index.

Returns: The ID of the specified row as an integer value.

Remarks: Returns -1 if the index is not valid. Rows may be reordered, but each row has a unique (within the table) ID that does not change.

◆ indexOfRow()

int OdDbBlockPropertiesTable::indexOfRow ( int id ) const

Gets the index of the specified row ID.

Parameters

id	[in] Row ID.

Returns: The index of the specified row ID.

Remarks: Returns -1 if the index is not valid. Rows may be reordered, but each row has a unique (within the table) ID that does not change.

◆ insertColumn()

void OdDbBlockPropertiesTable::insertColumn	(	const OdDbObjectId &	param,
		const OdString &	connection,
		int	after
	)

Inserts a column after the specified index.

Parameters

param	[in] ID of the column.
connection	[in] Connection for the column.
after	[in] Index of the column after which to insert.

Remarks: Throws the eInvalidIndex exception if the specified index is not valid.

◆ insertRow()

void OdDbBlockPropertiesTable::insertRow ( int after )

Inserts a row after the specified index.

Parameters

after [in] Index of the row after which to insert.

Remarks: Throws the eInvalidIndex exception if the specified index is not valid.

◆ isAngular()

bool OdDbBlockPropertiesTable::isAngular ( int column ) const

Checks whether the specified column is angular.

Parameters

column [in] Column index.

Returns: The true value if the specified column is angular, or false otherwise.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ isAttribute()

bool OdDbBlockPropertiesTable::isAttribute ( int ) const

Checks whether the specified column is an attribute.

Parameters

column [in] Column index.

Returns: The true value if the specified column is an attribute, or false otherwise.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ moveColumn()

void OdDbBlockPropertiesTable::moveColumn	(	int	from,
		int	to
	)

Moves the column from the original position to a new position.

Parameters

from	[in] Index from which to move the column.
to	[in] Index to which to move the column.

Remarks: Throws the eInvalidIndex exception if the from or to index is not valid. If the from and to indices are equal, exits the function.

◆ moveRow()

void OdDbBlockPropertiesTable::moveRow	(	int	from,
		int	to
	)

Moves the row from the original position to a new position.

Parameters

from	[in] Index from which to move the row.
to	[in] Index to which to move the row.

Remarks: Throws the eInvalidIndex exception if the from or to indices are not valid. If the from and to indices are equal, exits the function.

◆ mustMatch()

bool OdDbBlockPropertiesTable::mustMatch ( ) const

Checks whether the values of the parameters must match some rows.

Returns: The true value if the values of the parameters must match some rows, or false otherwise.

◆ numberOfColumns()

int OdDbBlockPropertiesTable::numberOfColumns ( ) const

Returns the number of columns in the table.

Returns: The number of columns in the table.

◆ numberOfRows()

int OdDbBlockPropertiesTable::numberOfRows ( ) const

Returns the number of rows in the table.

Returns: The number of rows in the table.

◆ ODDB_EVAL_DECLARE_MEMBERS()

OdDbBlockPropertiesTable::ODDB_EVAL_DECLARE_MEMBERS ( OdDbBlockPropertiesTable )

◆ removable()

bool OdDbBlockPropertiesTable::removable ( int column ) const

Checks whether the specified column is removable.

Parameters

column [in] Column index.

Returns: The true value if the specified column is removable, or false otherwise.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ removeColumn()

void OdDbBlockPropertiesTable::removeColumn ( int column )

Removes the column at the specified index.

Parameters

column [in] Index of column.

Remarks: Throws the eInvalidIndex exception if the specified index is not valid.

◆ removedFromGraph()

virtual void OdDbBlockPropertiesTable::removedFromGraph ( OdDbEvalGraph * pGraph )

virtual

Notification function called whenever this Node object has been removed a Graph object.

Parameters

pGraph [in] Pointer to the Graph object.

Remarks: Called by OdDbEvalGraph::removeNode().

This function is called after the operation.

Reimplemented from OdDbEvalExpr.

◆ removeRow()

void OdDbBlockPropertiesTable::removeRow ( int row )

Removes the row at the specified index.

Parameters

row	[in] Index of row.

Remarks: Throws the eInvalidIndex exception if the specified index is not valid.

◆ runtimeParametersOnly()

bool OdDbBlockPropertiesTable::runtimeParametersOnly ( ) const

Checks whether the parameters are only runtime.

Returns: The true value if the parameters are only runtime, or false otherwise.

◆ setCellValue()

OdResult OdDbBlockPropertiesTable::setCellValue	(	int	column,
		int	row,
		const OdResBuf *	rb
	)

Sets the value of the specified cell.

Parameters

column	[in] Column index.
row	[in] Row index.
rb	[out] The cell value to set.

Returns: Returns eOk if the indices are valid, or eInvalidInput otherwise.

◆ setConstant()

OdResult OdDbBlockPropertiesTable::setConstant	(	int	column,
		bool	val
	)

Specifies whether the column is constant.

Parameters

column	[in] Column index.
val	[in] Specify true to set that the column is constant, or false otherwise.

Returns: Returns eOk if the column is set to constant successfully, or eInvalidIndex otherwise.

◆ setCustomProperties()

void OdDbBlockPropertiesTable::setCustomProperties	(	int	column,
		const OdDbObjectId &	id
	)

Sets the ID of the custom properties.

Parameters

column	[in] Column index.
id	[in] ID of the custom properties.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ setDefaultActiveRow()

void OdDbBlockPropertiesTable::setDefaultActiveRow ( int row )

Changes the default values of the parameters used in the table.

Parameters

row	[in] Row index.

Remarks: Throws the eNotImplemented exception.

◆ setDefaultValue()

void OdDbBlockPropertiesTable::setDefaultValue	(	int	column,
		const OdResBuf *	rb
	)

Sets the default value of the specified column.

Parameters

column	[in] Column index.
rb	[in] Pointer to the default value of the specified column.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ setEditable()

OdResult OdDbBlockPropertiesTable::setEditable	(	int	column,
		bool	val
	)

Specifies whether the column is editable.

Parameters

column	[in] Column index.
val	[in] Specify true to set that the column is editable, or false otherwise.

Returns: Returns eOk if the index is valid, or eInvalidIndex otherwise.

◆ setFormat()

void OdDbBlockPropertiesTable::setFormat	(	int	column,
		const OdString &	f
	)

Sets the format of the specified column.

Parameters

column	[in] Column index.
f	[in] Format of the specified column.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ setMustMatch()

void OdDbBlockPropertiesTable::setMustMatch ( bool b )

Specifies whether the values of the parameters must match some rows.

Parameters

b	[in] Specify true to set that the values of the parameters must match some rows, or false otherwise.

◆ setRemovable()

OdResult OdDbBlockPropertiesTable::setRemovable	(	int	column,
		bool	val
	)

Specifies whether the column is removable.

Parameters

column	[in] Column index.
val	[in] Specify true to mark the column as removable, or false otherwise.

Returns: Returns eOk if the index is valid, or eInvalidIndex otherwise.

◆ setRuntimeParametersOnly()

void OdDbBlockPropertiesTable::setRuntimeParametersOnly ( bool b )

Specifies whether the parameters are only runtime parameters.

Parameters

b	[in] Specify true to set the parameters for only runtime, or false otherwise.

◆ setTableDescription()

void OdDbBlockPropertiesTable::setTableDescription ( const OdString & s )

Sets the table description.

Parameters

s	[in] The table description.

Remarks: The parameter value is used as the corresponding UI property description.

◆ setTableName()

void OdDbBlockPropertiesTable::setTableName ( const OdString & s )

Gets the name of the table.

Parameters

s	[in] The name of the table.

Remarks: The parameter value is used as the corresponding UI property name.

◆ setUnmatchedValue()

void OdDbBlockPropertiesTable::setUnmatchedValue	(	int	column,
		const OdResBuf *	rb
	)

Sets the unmatched value of the specified column.

Parameters

column	[in] Column index.
rb	[in] Unmatched value of the specified column.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

◆ sortRows()

void OdDbBlockPropertiesTable::sortRows	(	int	column,
		bool	ascending
	)

Sorts the rows.

Parameters

column	[in] Column index.
ascending	[in] Specify true to sort by ascending, or false to sort by descending.

Remarks: Throws the eInvalidIndex exception if the from or to indcies are not valid.

◆ tableAudit()

void OdDbBlockPropertiesTable::tableAudit ( OdArray< OdDbBPTAuditError > & )

Gets the column information into an array.

Remarks: Refer to the OdDbBPTAuditError::BPTAuditErrorType enumerated type for the available error types.

◆ tableDescription()

OdString OdDbBlockPropertiesTable::tableDescription ( ) const

Gets the table description.

Returns: The table description as an OdString value.

Remarks: The returned value is used as the corresponding UI property description.

◆ tableName()

OdString OdDbBlockPropertiesTable::tableName ( ) const

Gets the name of the table.

Returns: The name of the table as an OdString value.

Remarks: The returned value is used as the corresponding UI property name.

◆ unmatchedValue()

OdResBufPtr OdDbBlockPropertiesTable::unmatchedValue ( int column ) const

Gets the unmatched value of the specified column.

Parameters

column [in] Column index.

Returns: Unmatched value of the specified column as an OdResBufPtr object.

Remarks: Throws the eInvalidIndex exception if the column index is not valid.

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

DbBlockPropertiesTable.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdDbBlockPropertiesTable()

Member Function Documentation

◆ addedToGraph()

◆ appendColumn()

◆ appendRow()

◆ bptNodeId()

◆ columnValuesAreUnique()

◆ constant()

◆ customProperties()

◆ defaultValue()

◆ disabledInDrawingEditor()

◆ editable()

◆ erased()

◆ format()

◆ getCellValue()

◆ getCellValueString()

◆ GetColumnCount()

◆ getColumnName()

◆ getDefaultActiveRow()

◆ GetName()

◆ GetParameterId()

◆ GetRowCount()

◆ GetRowIndices()

◆ GetValue()

◆ idOfRow()

◆ indexOfRow()

◆ insertColumn()

◆ insertRow()

◆ isAngular()

◆ isAttribute()

◆ moveColumn()

◆ moveRow()

◆ mustMatch()

◆ numberOfColumns()

◆ numberOfRows()

◆ ODDB_EVAL_DECLARE_MEMBERS()

◆ removable()

◆ removeColumn()

◆ removedFromGraph()

◆ removeRow()

◆ runtimeParametersOnly()

◆ setCellValue()

◆ setConstant()

◆ setCustomProperties()

◆ setDefaultActiveRow()

◆ setDefaultValue()

◆ setEditable()

◆ setFormat()

◆ setMustMatch()

◆ setRemovable()

◆ setRuntimeParametersOnly()

◆ setTableDescription()

◆ setTableName()

◆ setUnmatchedValue()

◆ sortRows()

◆ tableAudit()

◆ tableDescription()

◆ tableName()

◆ unmatchedValue()