Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Static Public Member Functions
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.
More...

#include <TNaming_Tool.hxx>

Static Public Member Functions

static TopoDS_Shape CurrentShape (const Handle< TNaming_NamedShape > &NS)
 
 Returns the last Modification of <NS>. <br>

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.
More...

 
static TopoDS_Shape CurrentShape (const Handle< TNaming_NamedShape > &NS, const TDF_LabelMap &Updated)
 
 Returns the shape CurrentShape contained in <br>

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
More...

 
static 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.
More...
 
static Handle_TNaming_NamedShape CurrentNamedShape (const Handle< TNaming_NamedShape > &NS)
 Returns NamedShape the last Modification of <NS>.
More...
 
static Handle_TNaming_NamedShape NamedShape (const TopoDS_Shape &aShape, const TDF_Label &anAcces)
 
 Returns the named shape attribute defined by <br>

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)& );
};

Standard_Boolean
MyPkg_MyClass::SameEdge
(const Handle(OCafTest_Line)& L1
const Handle(OCafTest_Line)& L2)
{ Handle(TNaming_NamedShape)
NS1 = L1->NamedShape();
Handle(TNaming_NamedShape)
NS2 = L2->NamedShape();

return
BRepTools::Compare(NS1->Get(),NS2->Get());
}
In the example above, the function SameEdge is
created to compare the edges having two lines
for geometric supports. If these edges are found
by BRepTools::Compare to be within the same
tolerance, they are considered to be the same.
Warning
To avoid sharing of names, a SELECTED
attribute will not be returned. Sharing of names
makes it harder to manage the data structure.
When the user of the name is removed, for
example, it is difficult to know whether the name
should be destroyed.
More...

 
static TopoDS_Shape GetShape (const Handle< TNaming_NamedShape > &NS)
 
 Returns the entities stored in the named shape attribute NS. <br>

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.
More...

 
static TopoDS_Shape OriginalShape (const Handle< TNaming_NamedShape > &NS)
 Returns the shape contained as OldShape in <NS>
More...
 
static TopoDS_Shape GeneratedShape (const TopoDS_Shape &S, const Handle< TNaming_NamedShape > &Generation)
 
  Returns the shape generated from S or by a <br>

modification of S and contained in the named
shape Generation.
More...

 
static void Collect (const Handle< TNaming_NamedShape > &NS, TNaming_MapOfNamedShape &Labels, const Standard_Boolean OnlyModif=Standard_True)
 
static Standard_Boolean HasLabel (const TDF_Label &access, const TopoDS_Shape &aShape)
 Returns True if <aShape> appears under a label.(DP)
More...
 
static 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>.
More...
 
static 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.
More...
 
static Standard_Integer ValidUntil (const TDF_Label &access, const TopoDS_Shape &S)
 Returns the last transaction where the creation of S
is valid.
More...
 
static 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.
More...
 

Detailed Description

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.

Member Function Documentation

static void TNaming_Tool::Collect ( const Handle< TNaming_NamedShape > &  NS,
TNaming_MapOfNamedShape &  Labels,
const Standard_Boolean  OnlyModif = Standard_True 
)
static
static Handle_TNaming_NamedShape TNaming_Tool::CurrentNamedShape ( const Handle< TNaming_NamedShape > &  NS,
const TDF_LabelMap &  Updated 
)
static

Returns the NamedShape of the last Modification of <NS>.
This shape is identified by a label.

static Handle_TNaming_NamedShape TNaming_Tool::CurrentNamedShape ( const Handle< TNaming_NamedShape > &  NS)
static

Returns NamedShape the last Modification of <NS>.

static TopoDS_Shape TNaming_Tool::CurrentShape ( const Handle< TNaming_NamedShape > &  NS)
static 

 Returns the last Modification of <NS>. <br>

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 TopoDS_Shape TNaming_Tool::CurrentShape ( const Handle< TNaming_NamedShape > &  NS,
const TDF_LabelMap &  Updated 
)
static 

 Returns the shape CurrentShape contained in <br>

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 void TNaming_Tool::FindShape ( const TDF_LabelMap &  Valid,
const TDF_LabelMap &  Forbiden,
const Handle< TNaming_NamedShape > &  Arg,
TopoDS_Shape &  S 
)
static

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 TopoDS_Shape TNaming_Tool::GeneratedShape ( const TopoDS_Shape &  S,
const Handle< TNaming_NamedShape > &  Generation 
)
static 

  Returns the shape generated from S or by a <br>

modification of S and contained in the named
shape Generation.

static TopoDS_Shape TNaming_Tool::GetShape ( const Handle< TNaming_NamedShape > &  NS)
static 

 Returns the entities stored in the named shape attribute NS. <br>

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_Boolean TNaming_Tool::HasLabel ( const TDF_Label &  access,
const TopoDS_Shape &  aShape 
)
static

Returns True if <aShape> appears under a label.(DP)

static TopoDS_Shape TNaming_Tool::InitialShape ( const TopoDS_Shape &  aShape,
const TDF_Label &  anAcces,
TDF_LabelList &  Labels 
)
static

Returns the shape created from the shape
aShape contained in the attribute anAcces.

static TDF_Label TNaming_Tool::Label ( const TDF_Label &  access,
const TopoDS_Shape &  aShape,
Standard_Integer &  TransDef 
)
static

Returns the label of the first apparition of
<aShape>. Transdef is a value of the transaction
of the first apparition of <aShape>.

static Handle_TNaming_NamedShape TNaming_Tool::NamedShape ( const TopoDS_Shape &  aShape,
const TDF_Label &  anAcces 
)
static 

 Returns the named shape attribute defined by <br>

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)& );
};

Standard_Boolean
MyPkg_MyClass::SameEdge
(const Handle(OCafTest_Line)& L1
const Handle(OCafTest_Line)& L2)
{ Handle(TNaming_NamedShape)
NS1 = L1->NamedShape();
Handle(TNaming_NamedShape)
NS2 = L2->NamedShape();

return
BRepTools::Compare(NS1->Get(),NS2->Get());
}
In the example above, the function SameEdge is
created to compare the edges having two lines
for geometric supports. If these edges are found
by BRepTools::Compare to be within the same
tolerance, they are considered to be the same.
Warning
To avoid sharing of names, a SELECTED
attribute will not be returned. Sharing of names
makes it harder to manage the data structure.
When the user of the name is removed, for
example, it is difficult to know whether the name
should be destroyed.

static TopoDS_Shape TNaming_Tool::OriginalShape ( const Handle< TNaming_NamedShape > &  NS)
static

Returns the shape contained as OldShape in <NS>

static Standard_Integer TNaming_Tool::ValidUntil ( const TDF_Label &  access,
const TopoDS_Shape &  S 
)
static

Returns the last transaction where the creation of S
is valid.

The documentation for this class was generated from the following file:
Generated on Tue Apr 29 2014 15:39:32 for Open CASCADE Technology by   doxygen 1.8.5