OCC Main Page | ApplicationFramework | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# ApplicationFramework
TKLCAF
TNaming

# TNaming_Tool Class Reference

A tool to get information on the topology of a
named shape attribute.
This information is typically a TopoDS_Shape object.
Using this tool, relations between named shapes
are also accessible.
.

`#include <TNaming_Tool.hxx>`

## Public Member Functions
void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
## Static Public Member Functions
static Standard_EXPORT TopoDS_Shape | CurrentShape (const Handle(TNaming_NamedShape)&NS)
| Returns the last Modification of <ns>. Returns the shape CurrentShape contained in the named shape attribute NS. CurrentShape is the current state of the entities if they have been modified in other attributes of the same data structure. Each call to this function creates a new compound. .
static Standard_EXPORT TopoDS_Shape | CurrentShape (const Handle(TNaming_NamedShape)&NS, const TDF_LabelMap &Updated)
| Returns the shape CurrentShape contained in the named shape attribute NS, and present in the updated attribute map Updated. CurrentShape is the current state of the entities if they have been modified in other attributes of the same data structure. Each call to this function creates a new compound. Warning Only the contents of Updated are searched.R .
static Standard_EXPORT Handle_TNaming_NamedShape | CurrentNamedShape (const Handle(TNaming_NamedShape)&NS, const TDF_LabelMap &Updated)
| Returns the NamedShape of the last Modification of <ns>. This shape is identified by a label. .
static Standard_EXPORT Handle_TNaming_NamedShape | CurrentNamedShape (const Handle(TNaming_NamedShape)&NS)
| Returns NamedShape the last Modification of <ns>. .
static Standard_EXPORT Handle_TNaming_NamedShape | NamedShape (const TopoDS_Shape &aShape, const TDF_Label &anAcces)
| Returns the named shape attribute defined by the shape aShape and the label anAccess. This attribute is returned as a new shape. You call this function, if you need to create a topological attribute for existing data. Example class MyPkg_MyClass { public: Standard_Boolean SameEdge(const Handle(OCafTest_Line)& , const Handle(CafTest_Line)& ); }; .
static Standard_EXPORT TopoDS_Shape | GetShape (const Handle(TNaming_NamedShape)&NS)
| Returns the entities stored in the named shape attribute NS. If there is only one old-new pair, the new shape is returned. Otherwise, a Compound is returned. This compound is made out of all the new shapes found. Each call to this function creates a new compound. .
static Standard_EXPORT TopoDS_Shape | OriginalShape (const Handle(TNaming_NamedShape)&NS)
| Returns the shape contained as OldShape in <ns> .
static Standard_EXPORT TopoDS_Shape | GeneratedShape (const TopoDS_Shape &S, const Handle(TNaming_NamedShape)&Generation)
| Returns the shape generated from S or by a modification of S and contained in the named shape Generation. .
static Standard_EXPORT void | Collect (const Handle(TNaming_NamedShape)&NS, TNaming_MapOfNamedShape &Labels, const Standard_Boolean OnlyModif=Standard_True)
static Standard_EXPORT Standard_Boolean | HasLabel (const TDF_Label &access, const TopoDS_Shape &aShape)
| Returns True if <ashape> appears under a label.(DP) .
static Standard_EXPORT TDF_Label | Label (const TDF_Label &access, const TopoDS_Shape &aShape, Standard_Integer &TransDef)
| Returns the label of the first apparition of <ashape>. Transdef is a value of the transaction of the first apparition of <ashape>. .
static Standard_EXPORT TopoDS_Shape | InitialShape (const TopoDS_Shape &aShape, const TDF_Label &anAcces, TDF_LabelList &Labels)
| Returns the shape created from the shape aShape contained in the attribute anAcces. .
static Standard_EXPORT Standard_Integer | ValidUntil (const TDF_Label &access, const TopoDS_Shape &S)
| Returns the last transaction where the creation of S is valid. .
static Standard_EXPORT void | FindShape (const TDF_LabelMap &Valid, const TDF_LabelMap &Forbiden, const Handle(TNaming_NamedShape)&Arg, TopoDS_Shape &S)
| Returns the current shape (a Wire or a Shell) built (in the data framework) from the the shapes of the argument named shape. It is used for IDENTITY name type computation. .
## Static Private Member Functions
static Standard_EXPORT Standard_Boolean | HasLabel (const Handle(TNaming_UsedShapes)&Shapes, const TopoDS_Shape &aShape)
| Returns True if <ashape> appears under a label. .
static Standard_EXPORT Standard_Integer | ValidUntil (const TopoDS_Shape &S, const Handle(TNaming_UsedShapes)&US)
| Returns the last transaction where the creation of S is valid. .
static Standard_EXPORT TDF_Label | Label (const Handle(TNaming_UsedShapes)&Shapes, const TopoDS_Shape &aShape, Standard_Integer &TransDef)
| Returns the label of the first apparition of <ashape>. Transdef is a value of the transaction of the first apparition of <ashape>. .
static Standard_EXPORT void | FirstOlds (const Handle(TNaming_UsedShapes)&Shapes, const TopoDS_Shape &S, TNaming_OldShapeIterator &it, TopTools_MapOfShape &MS, TDF_LabelList &Labels)

## Member Function Documentation

static Standard_EXPORT void TNaming_Tool::Collect | ( | const Handle(TNaming_NamedShape)& | NS,
|  | TNaming_MapOfNamedShape & | Labels,
|  | const Standard_Boolean | OnlyModif = `Standard_True`
| ) | `[static]`

static Standard_EXPORT Handle_TNaming_NamedShape TNaming_Tool::CurrentNamedShape | ( | const Handle(TNaming_NamedShape)& | NS | ) | `[static]`

static Standard_EXPORT Handle_TNaming_NamedShape TNaming_Tool::CurrentNamedShape | ( | const Handle(TNaming_NamedShape)& | NS,
|  | const TDF_LabelMap & | Updated
| ) | `[static]`

static Standard_EXPORT TopoDS_Shape TNaming_Tool::CurrentShape | ( | const Handle(TNaming_NamedShape)& | NS,
|  | const TDF_LabelMap & | Updated
| ) | `[static]`

static Standard_EXPORT TopoDS_Shape TNaming_Tool::CurrentShape | ( | const Handle(TNaming_NamedShape)& | NS | ) | `[static]`

static Standard_EXPORT void TNaming_Tool::FindShape | ( | const TDF_LabelMap & | Valid,
|  | const TDF_LabelMap & | Forbiden,
|  | const Handle(TNaming_NamedShape)& | Arg,
|  | TopoDS_Shape & | S
| ) | `[static]`

static Standard_EXPORT void TNaming_Tool::FirstOlds | ( | const Handle(TNaming_UsedShapes)& | Shapes,
|  | const TopoDS_Shape & | S,
|  | TNaming_OldShapeIterator & | it,
|  | TopTools_MapOfShape & | MS,
|  | TDF_LabelList & | Labels
| ) | `[static, private]`

static Standard_EXPORT TopoDS_Shape TNaming_Tool::GeneratedShape | ( | const TopoDS_Shape & | S,
|  | const Handle(TNaming_NamedShape)& | Generation
| ) | `[static]`

static Standard_EXPORT TopoDS_Shape TNaming_Tool::GetShape | ( | const Handle(TNaming_NamedShape)& | NS | ) | `[static]`

static Standard_EXPORT Standard_Boolean TNaming_Tool::HasLabel | ( | const Handle(TNaming_UsedShapes)& | Shapes,
|  | const TopoDS_Shape & | aShape
| ) | `[static, private]`

static Standard_EXPORT Standard_Boolean TNaming_Tool::HasLabel | ( | const TDF_Label & | access,
|  | const TopoDS_Shape & | aShape
| ) | `[static]`

static Standard_EXPORT TopoDS_Shape TNaming_Tool::InitialShape | ( | const TopoDS_Shape & | aShape,
|  | const TDF_Label & | anAcces,
|  | TDF_LabelList & | Labels
| ) | `[static]`

static Standard_EXPORT TDF_Label TNaming_Tool::Label | ( | const Handle(TNaming_UsedShapes)& | Shapes,
|  | const TopoDS_Shape & | aShape,
|  | Standard_Integer & | TransDef
| ) | `[static, private]`

static Standard_EXPORT TDF_Label TNaming_Tool::Label | ( | const TDF_Label & | access,
|  | const TopoDS_Shape & | aShape,
|  | Standard_Integer & | TransDef
| ) | `[static]`

static Standard_EXPORT Handle_TNaming_NamedShape TNaming_Tool::NamedShape | ( | const TopoDS_Shape & | aShape,
|  | const TDF_Label & | anAcces
| ) | `[static]`

void TNaming_Tool::operator delete | ( | void * | anAddress | ) | `[inline]`

void* TNaming_Tool::operator new | ( | size_t | size | ) | `[inline]`

void* TNaming_Tool::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

static Standard_EXPORT TopoDS_Shape TNaming_Tool::OriginalShape | ( | const Handle(TNaming_NamedShape)& | NS | ) | `[static]`

static Standard_EXPORT Standard_Integer TNaming_Tool::ValidUntil | ( | const TopoDS_Shape & | S,
|  | const Handle(TNaming_UsedShapes)& | US
| ) | `[static, private]`

static Standard_EXPORT Standard_Integer TNaming_Tool::ValidUntil | ( | const TDF_Label & | access,
|  | const TopoDS_Shape & | S
| ) | `[static]`

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

- TNaming_Tool.hxx