Open CASCADE Technology 6.6.0
Public Member Functions | Static Public Member Functions
XCAFDoc_DimTolTool Class Reference

Provides tools to store and retrieve attributes (colors)
of TopoDS_Shape in and from TDocStd_Document
A Document is intended to hold different
attributes of ONE shape and it's sub-shapes

#include <XCAFDoc_DimTolTool.hxx>

Inheritance diagram for XCAFDoc_DimTolTool:
Inheritance graph
[legend]

Public Member Functions

 XCAFDoc_DimTolTool ()
TDF_Label BaseLabel () const
 returns the label under which colors are stored

const Handle_XCAFDoc_ShapeTool & ShapeTool ()
 Returns internal XCAFDoc_ShapeTool tool

Standard_Boolean IsDimTol (const TDF_Label &lab) const
 Returns True if label belongs to a dimtoltable and
is a DimTol definition

void GetDimTolLabels (TDF_LabelSequence &Labels) const
 Returns a sequence of D&GTs currently stored
in the DGTtable

Standard_Boolean FindDimTol (const Standard_Integer kind, const Handle< TColStd_HArray1OfReal > &aVal, const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription, TDF_Label &lab) const
 Finds a dimtol definition in a DGTtable and returns
its label if found
Returns False if dimtol is not found in DGTtable

TDF_Label FindDimTol (const Standard_Integer kind, const Handle< TColStd_HArray1OfReal > &aVal, const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription) const
 Finds a dimtol definition in a DGTtable and returns
its label if found (or Null label else)

TDF_Label AddDimTol (const Standard_Integer kind, const Handle< TColStd_HArray1OfReal > &aVal, const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription) const
 Adds a dimtol definition to a DGTtable and returns its label

void SetDimTol (const TDF_Label &L, const TDF_Label &DimTolL) const
 Sets a link with GUID

TDF_Label SetDimTol (const TDF_Label &L, const Standard_Integer kind, const Handle< TColStd_HArray1OfReal > &aVal, const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription) const
 Sets a link with GUID
Adds a DimTol as necessary

Standard_Boolean GetRefShapeLabel (const TDF_Label &DimTolL, TDF_Label &ShapeL) const
 Returns ShapeL defined for label DimTolL
Returns False if the DimTolL is not in DGTtable

Standard_Boolean GetRefDGTLabels (const TDF_Label &ShapeL, TDF_LabelSequence &DimTols) const
 Returns all DimTol labels defined for label ShapeL

Standard_Boolean GetDimTol (const TDF_Label &DimTolL, Standard_Integer &kind, Handle< TColStd_HArray1OfReal > &aVal, Handle< TCollection_HAsciiString > &aName, Handle< TCollection_HAsciiString > &aDescription) const
 Returns dimtol assigned to <DimTolL>
Returns False if no such dimtol is assigned

Standard_Boolean IsDatum (const TDF_Label &lab) const
 Returns True if label belongs to a dimtoltable and
is a Datum definition

void GetDatumLabels (TDF_LabelSequence &Labels) const
 Returns a sequence of Datumss currently stored
in the DGTtable

Standard_Boolean FindDatum (const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription, const Handle< TCollection_HAsciiString > &anIdentification, TDF_Label &lab) const
 Finds a datum and returns its label if found

TDF_Label AddDatum (const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription, const Handle< TCollection_HAsciiString > &anIdentification) const
 Adds a datum definition to a DGTtable and returns its label

void SetDatum (const TDF_Label &L, const TDF_Label &DatumL) const
 Sets a link with GUID

void SetDatum (const TDF_Label &L, const TDF_Label &TolerL, const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription, const Handle< TCollection_HAsciiString > &anIdentification) const
 Sets a link with GUID for Datum
Adds a Datum as necessary
Sets connection between Datum and Tolerance

Standard_Boolean GetDatum (const TDF_Label &DatumL, Handle< TCollection_HAsciiString > &aName, Handle< TCollection_HAsciiString > &aDescription, Handle< TCollection_HAsciiString > &anIdentification) const
 Returns datum assigned to <DatumL>
Returns False if no such datum is assigned

Standard_Boolean GetDatumTolerLabels (const TDF_Label &DimTolL, TDF_LabelSequence &Datums) const
 Returns all Datum labels defined for label DimTolL

const Standard_GUIDID () const
 Returns the ID of the attribute.


void Restore (const Handle< TDF_Attribute > &with)
 Restores the backuped contents from <anAttribute>
into this one. It is used when aborting a
transaction.

Handle_TDF_Attribute NewEmpty () const
 Returns an new empty attribute from the good end
type. It is used by the copy algorithm.

void Paste (const Handle< TDF_Attribute > &into, const Handle< TDF_RelocationTable > &RT) const
 This method is different from the "Copy" one,
because it is used when copying an attribute from
a source structure into a target structure. This
method may paste the contents of <me> into
<intoAttribute>.

The given pasted attribute can be full or empty of
its contents. But don't make a NEW! Just set the
contents!

It is possible to use <aRelocationTable> to
get/set the relocation value of a source
attribute.

Static Public Member Functions

static Handle_XCAFDoc_DimTolTool Set (const TDF_Label &L)
 Creates (if not exist) DimTolTool.

static const Standard_GUIDGetID ()

Constructor & Destructor Documentation

XCAFDoc_DimTolTool::XCAFDoc_DimTolTool ( )

Member Function Documentation

TDF_Label XCAFDoc_DimTolTool::AddDatum ( const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription,
const Handle< TCollection_HAsciiString > &  anIdentification 
) const
TDF_Label XCAFDoc_DimTolTool::AddDimTol ( const Standard_Integer  kind,
const Handle< TColStd_HArray1OfReal > &  aVal,
const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription 
) const
TDF_Label XCAFDoc_DimTolTool::BaseLabel ( ) const
Standard_Boolean XCAFDoc_DimTolTool::FindDatum ( const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription,
const Handle< TCollection_HAsciiString > &  anIdentification,
TDF_Label lab 
) const
TDF_Label XCAFDoc_DimTolTool::FindDimTol ( const Standard_Integer  kind,
const Handle< TColStd_HArray1OfReal > &  aVal,
const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription 
) const
Standard_Boolean XCAFDoc_DimTolTool::FindDimTol ( const Standard_Integer  kind,
const Handle< TColStd_HArray1OfReal > &  aVal,
const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription,
TDF_Label lab 
) const
Standard_Boolean XCAFDoc_DimTolTool::GetDatum ( const TDF_Label DatumL,
Handle< TCollection_HAsciiString > &  aName,
Handle< TCollection_HAsciiString > &  aDescription,
Handle< TCollection_HAsciiString > &  anIdentification 
) const
void XCAFDoc_DimTolTool::GetDatumLabels ( TDF_LabelSequence Labels) const
Standard_Boolean XCAFDoc_DimTolTool::GetDatumTolerLabels ( const TDF_Label DimTolL,
TDF_LabelSequence Datums 
) const
Standard_Boolean XCAFDoc_DimTolTool::GetDimTol ( const TDF_Label DimTolL,
Standard_Integer kind,
Handle< TColStd_HArray1OfReal > &  aVal,
Handle< TCollection_HAsciiString > &  aName,
Handle< TCollection_HAsciiString > &  aDescription 
) const
void XCAFDoc_DimTolTool::GetDimTolLabels ( TDF_LabelSequence Labels) const
static const Standard_GUID& XCAFDoc_DimTolTool::GetID ( ) [static]
Standard_Boolean XCAFDoc_DimTolTool::GetRefDGTLabels ( const TDF_Label ShapeL,
TDF_LabelSequence DimTols 
) const
Standard_Boolean XCAFDoc_DimTolTool::GetRefShapeLabel ( const TDF_Label DimTolL,
TDF_Label ShapeL 
) const
const Standard_GUID& XCAFDoc_DimTolTool::ID ( ) const [virtual]

Implements TDF_Attribute.

Standard_Boolean XCAFDoc_DimTolTool::IsDatum ( const TDF_Label lab) const
Standard_Boolean XCAFDoc_DimTolTool::IsDimTol ( const TDF_Label lab) const
Handle_TDF_Attribute XCAFDoc_DimTolTool::NewEmpty ( ) const [virtual]

Implements TDF_Attribute.

void XCAFDoc_DimTolTool::Paste ( const Handle< TDF_Attribute > &  intoAttribute,
const Handle< TDF_RelocationTable > &  aRelocationTable 
) const [virtual]

Implements TDF_Attribute.

void XCAFDoc_DimTolTool::Restore ( const Handle< TDF_Attribute > &  anAttribute) [virtual]

Implements TDF_Attribute.

static Handle_XCAFDoc_DimTolTool XCAFDoc_DimTolTool::Set ( const TDF_Label L) [static]
void XCAFDoc_DimTolTool::SetDatum ( const TDF_Label L,
const TDF_Label DatumL 
) const
void XCAFDoc_DimTolTool::SetDatum ( const TDF_Label L,
const TDF_Label TolerL,
const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription,
const Handle< TCollection_HAsciiString > &  anIdentification 
) const
TDF_Label XCAFDoc_DimTolTool::SetDimTol ( const TDF_Label L,
const Standard_Integer  kind,
const Handle< TColStd_HArray1OfReal > &  aVal,
const Handle< TCollection_HAsciiString > &  aName,
const Handle< TCollection_HAsciiString > &  aDescription 
) const
void XCAFDoc_DimTolTool::SetDimTol ( const TDF_Label L,
const TDF_Label DimTolL 
) const
const Handle_XCAFDoc_ShapeTool& XCAFDoc_DimTolTool::ShapeTool ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines