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

DataExchange
TKXCAF
XCAFDoc


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>


Public Member Functions

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

Standard_EXPORT const Handle_XCAFDoc_ShapeTool & ShapeTool ()
 Returns internal XCAFDoc_ShapeTool tool
.
Standard_EXPORT Standard_Boolean IsDimTol (const TDF_Label &lab) const
 Returns True if label belongs to a dimtoltable and
is a DimTol definition
.
Standard_EXPORT void GetDimTolLabels (TDF_LabelSequence &Labels) const
 Returns a sequence of D&GTs currently stored
in the DGTtable
.
Standard_EXPORT 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
.
Standard_EXPORT 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)
.
Standard_EXPORT 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
.
Standard_EXPORT void SetDimTol (const TDF_Label &L, const TDF_Label &DimTolL) const
 Sets a link with GUID
.
Standard_EXPORT 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_EXPORT 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_EXPORT Standard_Boolean GetRefDGTLabels (const TDF_Label &ShapeL, TDF_LabelSequence &DimTols) const
 Returns all DimTol labels defined for label ShapeL
.
Standard_EXPORT 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_EXPORT Standard_Boolean IsDatum (const TDF_Label &lab) const
 Returns True if label belongs to a dimtoltable and
is a Datum definition
.
Standard_EXPORT void GetDatumLabels (TDF_LabelSequence &Labels) const
 Returns a sequence of Datumss currently stored
in the DGTtable
.
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT void SetDatum (const TDF_Label &L, const TDF_Label &DatumL) const
 Sets a link with GUID
.
Standard_EXPORT 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_EXPORT 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_EXPORT Standard_Boolean GetDatumTolerLabels (const TDF_Label &DimTolL, TDF_LabelSequence &Datums) const
 Returns all Datum labels defined for label DimTolL
.
Standard_EXPORT const Standard_GUID & ID () const
Standard_EXPORT void Restore (const Handle(TDF_Attribute)&with)
Standard_EXPORT Handle_TDF_Attribute NewEmpty () const
Standard_EXPORT void Paste (const Handle(TDF_Attribute)&into, const Handle(TDF_RelocationTable)&RT) const
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

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

Private Attributes

Handle_XCAFDoc_ShapeTool myShapeTool


Constructor & Destructor Documentation

Standard_EXPORT XCAFDoc_DimTolTool::XCAFDoc_DimTolTool  ) 
 


Member Function Documentation

Standard_EXPORT TDF_Label XCAFDoc_DimTolTool::AddDatum const Handle(TCollection_HAsciiString)&  aName,
const Handle(TCollection_HAsciiString)&  aDescription,
const Handle(TCollection_HAsciiString)&  anIdentification
const
 

Standard_EXPORT 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
 

Standard_EXPORT TDF_Label XCAFDoc_DimTolTool::BaseLabel  )  const
 

Standard_EXPORT Standard_Boolean XCAFDoc_DimTolTool::FindDatum const Handle(TCollection_HAsciiString)&  aName,
const Handle(TCollection_HAsciiString)&  aDescription,
const Handle(TCollection_HAsciiString)&  anIdentification,
TDF_Label &  lab
const
 

Standard_EXPORT 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_EXPORT 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_EXPORT Standard_Boolean XCAFDoc_DimTolTool::GetDatum const TDF_Label &  DatumL,
Handle(TCollection_HAsciiString)&  aName,
Handle(TCollection_HAsciiString)&  aDescription,
Handle(TCollection_HAsciiString)&  anIdentification
const
 

Standard_EXPORT void XCAFDoc_DimTolTool::GetDatumLabels TDF_LabelSequence &  Labels  )  const
 

Standard_EXPORT Standard_Boolean XCAFDoc_DimTolTool::GetDatumTolerLabels const TDF_Label &  DimTolL,
TDF_LabelSequence &  Datums
const
 

Standard_EXPORT 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
 

Standard_EXPORT void XCAFDoc_DimTolTool::GetDimTolLabels TDF_LabelSequence &  Labels  )  const
 

static Standard_EXPORT const Standard_GUID& XCAFDoc_DimTolTool::GetID  )  [static]
 

Standard_EXPORT Standard_Boolean XCAFDoc_DimTolTool::GetRefDGTLabels const TDF_Label &  ShapeL,
TDF_LabelSequence &  DimTols
const
 

Standard_EXPORT Standard_Boolean XCAFDoc_DimTolTool::GetRefShapeLabel const TDF_Label &  DimTolL,
TDF_Label &  ShapeL
const
 

Standard_EXPORT const XCAFDoc_DimTolTool::Handle Standard_Type   )  const
 

Standard_EXPORT const Standard_GUID& XCAFDoc_DimTolTool::ID  )  const
 

Standard_EXPORT Standard_Boolean XCAFDoc_DimTolTool::IsDatum const TDF_Label &  lab  )  const
 

Standard_EXPORT Standard_Boolean XCAFDoc_DimTolTool::IsDimTol const TDF_Label &  lab  )  const
 

Standard_EXPORT Handle_TDF_Attribute XCAFDoc_DimTolTool::NewEmpty  )  const
 

Standard_EXPORT void XCAFDoc_DimTolTool::Paste const Handle(TDF_Attribute)&  into,
const Handle(TDF_RelocationTable)&  RT
const
 

Standard_EXPORT void XCAFDoc_DimTolTool::Restore const Handle(TDF_Attribute)&  with  ) 
 

static Standard_EXPORT Handle_XCAFDoc_DimTolTool XCAFDoc_DimTolTool::Set const TDF_Label &  L  )  [static]
 

Standard_EXPORT 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
 

Standard_EXPORT void XCAFDoc_DimTolTool::SetDatum const TDF_Label &  L,
const TDF_Label &  DatumL
const
 

Standard_EXPORT 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
 

Standard_EXPORT void XCAFDoc_DimTolTool::SetDimTol const TDF_Label &  L,
const TDF_Label &  DimTolL
const
 

Standard_EXPORT const Handle_XCAFDoc_ShapeTool& XCAFDoc_DimTolTool::ShapeTool  ) 
 


Field Documentation

Handle_XCAFDoc_ShapeTool XCAFDoc_DimTolTool::myShapeTool [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:46:15 2008 for OpenCASCADE by  doxygen 1.4.1