#include <DbEvalGraph.h>
Protected Attributes | |
| OdResBufPtr | m_lastValue |
 Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Friends | |
| class | OdDbEvalExprImpl |
Detailed Description
This class represents single nodes in OdDbEvalGraph objects.
- Remarks
- Each node reprsents an action or expression. The OdDbEvalGraph object calls each owned node's evaluate() method while traversing the graph within the OdDbEvalGraph::evaluate() method.
Corresponding C++ library: TD_DynBlocks <group OdDb_Classes>
- See also
- OdDbEvalConnectable OdDbEvalContext OdDbEvalContextIterator OdDbEvalContextPair OdDbEvalEdgeInfo OdDbEvalGraph
Definition at line 588 of file DbEvalGraph.h.
Constructor & Destructor Documentation
◆ OdDbEvalExpr()
| OdDbEvalExpr::OdDbEvalExpr | ( | ) |
◆ ~OdDbEvalExpr()
|
virtual |
Member Function Documentation
◆ activated()
|
virtual |
Notification function called whenever this Node object has been activated.
- Parameters
-
argumentActivateList [in] Array of node IDs being activated.
- Remarks
- Called by OdDbEvalGraph::activate() or by OdDbEvalGraph::evaluate().
When the edge is invertible, this function is called twice.
This function is called after the operation.
◆ addedToGraph()
|
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 in OdDbBlockGrip, and OdDbBlockPropertiesTable.
◆ adjacentEdgeAdded()
|
virtual |
Notification function called whenever an edge has been added the Graph object.
- Parameters
-
fromId [in] Node Id of the "from" Node object sharing the edge. toId [in] Node Id of the "to" Node object sharing the edge. isInvertible [in] True if and only if the edge the edge is invertible.
- Remarks
- Called by OdDbEvalGraph::addEdge().
When the edge is invertible, this function is called twice.
This function is called after the operation.
◆ adjacentEdgeRemoved()
|
virtual |
Notification function called whenever an edge of this Node object has been removed.
- Parameters
-
adjEdgeNodeId [in] Node Id of the Node object sharing the edge.
- Remarks
- Called by OdDbEvalGraph::removeEdge().
This function is called after the operation.
◆ adjacentNodeRemoved()
|
virtual |
Notification function called whenever a Node object with a shared edge to this Node object has been removed a Graph object.
- Parameters
-
adjNodeId [in] Node Id of the adjacent Node object.
- Remarks
- Called by OdDbEvalGraph::removeNode().
This function is called after the operation.
◆ copiedIntoGraph()
|
virtual |
Notification function called whenever a Node object has been copied to another Graph object.
- Parameters
-
pIntoGraph [in] Pointer to the Graph object into which a Node object was copied.
- Remarks
- Called by OdDbEvalGraph::copyFrom().
This function is called after the operation.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
Reimplemented in OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, and OdDbShWedge.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
Reimplemented in OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, and OdDbShWedge.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
Reimplemented in OdDbBlockXYGrip, OdDbBlockPolarGrip, OdDbBlockRotationGrip, OdDbBlockLookupGrip, OdDbBlockVisibilityGrip, OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, and OdDbShWedge.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
Reimplemented in OdDbBlockXYGrip, OdDbBlockPolarGrip, OdDbBlockRotationGrip, OdDbBlockLookupGrip, OdDbBlockVisibilityGrip, OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, and OdDbShWedge.
◆ equals()
|
virtual |
Returns true if and only if the specified Node object is equal to this Node object.
- Parameters
-
pOther [in] Pointer to the other Node object.
- Remarks
- The default implementation of this function does nothing but throw an eNotImplemented error.
◆ evaluate()
|
virtual |
Evaluates the expression represented by this Node object.
- Parameters
-
evalContext [in] Evaluation context.
- Remarks
- Called by OdDbEvalGraph::evaluate().
Returns true if and only if successful. Returning false terminates the Traversal.
evalContext may be NULL.
Reimplemented in OdDbBlockElement, and OdDbShHistoryNode.
◆ getGraph()
| OdDbEvalGraphPtr OdDbEvalExpr::getGraph | ( | OdDb::OpenMode | openMode = OdDb::kForRead | ) | const |
Opens the OdDbEvalGraph object that owns this Node object.
- Parameters
-
openMode [in] Mode in which to open the Graph object.
- Returns
- Returns a SmartPointer to the opened OdDbEvalGraph if successful, otherwise a null SmartPointer.
◆ graphEvalAbort()
|
virtual |
Notification function called whenever the Graph object travesal is been terminated.
- Parameters
-
nodeIsActive [in] True if and only if this Node object has been activated.
- Remarks
- Called by OdDbEvalGraph::evaluate().
This function is called after the operation.
◆ graphEvalEnd()
|
virtual |
Notification function called whenever the Graph object has been traversed.
- Parameters
-
nodeIsActive [in] True if and only if this Node object has been activated.
- Remarks
- Called by OdDbEvalGraph::evaluate().
This function is called after the operation.
Reimplemented in OdDbBlock1PtParameter, OdDbBlock2PtParameter, OdDbBlockFlipParameter, OdDbBlockFlipGrip, and OdDbBlockRotationParameter.
◆ graphEvalStart()
|
virtual |
Notification function called whenever the Graph object is about to be traversed.
- Parameters
-
nodeIsActive [in] True if and only if this Node object has been activated.
- Remarks
- Called by OdDbEvalGraph::evaluate().
This function is called before the operation.
◆ isActivatable()
|
virtual |
Returns true if and only if this Node object can be activated.
- Remarks
- The default implementation of this function always returns true.
◆ movedFromGraph()
|
virtual |
Notification function called whenever this Node object is about to be moved to another Graph object.
- Parameters
-
pFromGraph [in] Pointer to the Graph object from which this Node object will be moved.
- Remarks
- Called by OdDbEvalGraph::addGraph().
This function is called before the operation.
◆ movedIntoGraph()
|
virtual |
Notification function called whenever this Node object has been moved to another Graph object.
- Parameters
-
pIntoGraph [in] Pointer to the Graph object into which this Node object was moved.
- Remarks
- Called by OdDbEvalGraph::addGraph().
This function is called after the operation.
◆ nodeId()
| OdDbEvalNodeId OdDbEvalExpr::nodeId | ( | ) | const |
Returns the node ID of this Node object.
- Remarks
- An unique ID is assigned when a Node object it added to a Graph.
Returns OdDbGraph::kNullId if this Node object is not graph-resident.
◆ ODDB_DECLARE_MEMBERS()
| OdDbEvalExpr::ODDB_DECLARE_MEMBERS | ( | OdDbEvalExpr | ) |
◆ postInDatabase()
|
virtual |
◆ remappedNodeIds()
|
virtual |
OdDbEvalGraph::addGraph() calls this method on each node in the to-be-added graph just after all nodes have been added to the destination graph. The default behavior is to do nothing. Some subclasses of OdDbEvalExpr should override this function to update their references to other nodes. Nodes should not alter the map. This function is called exactly once for each node in a graph after all node IDs in a graph are changed.
◆ removedFromGraph()
|
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 in OdDbBlockGrip, and OdDbBlockPropertiesTable.
◆ value()
| OdResBufPtr OdDbEvalExpr::value | ( | ) | const |
Returns the value of the evaluated expression of this Node object.
- Remarks
- The value is updated with a call to OdDbEvalExpr::evaluate().
Friends And Related Function Documentation
◆ OdDbEvalExprImpl
|
friend |
Definition at line 835 of file DbEvalGraph.h.
Member Data Documentation
◆ m_lastValue
|
protected |
Definition at line 834 of file DbEvalGraph.h.
The documentation for this class was generated from the following file: