OCC.Core.XCAFDimTolObjects module

XCAFDimTolObjects module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_xcafdimtolobjects.html

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class XCAFDimTolObjects_DataMapOfToleranceDatum(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class XCAFDimTolObjects_DatumModifiersSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class XCAFDimTolObjects_DatumObject(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None:param theObj: :type theObj: XCAFDimTolObjects_DatumObject :rtype: None

AddModifier()

• Adds a modifier to the datum sequence of modifiers.

  param theModifier

  type theModifier

  XCAFDimTolObjects_DatumSingleModif

  rtype

  None

static DownCast(t)

GetDatumTarget()

• Returns datum target shape.

  rtype

  TopoDS_Shape

GetDatumTargetAxis()

• Returns datum target axis. The Z axis of the datum placement denotes the normal of the surface pointing away from the material.

  rtype

  gp_Ax2

GetDatumTargetLength()

• Returns datum target length for line and rectangle types. The length along the X axis of the datum placement.

  rtype

  float

GetDatumTargetNumber()

• Returns datum target number.

  rtype

  int

GetDatumTargetType()

• Returns datum target type

  rtype

  XCAFDimTolObjects_DatumTargetType

GetDatumTargetWidth()

• Returns datum target width for rectangle type. The width along the derived Y axis, with the placement itself positioned at the centre of the rectangle.

  rtype

  float

GetModifierWithValue()

• Retrieves datum modifier with value.

  param theModifier

  type theModifier

  XCAFDimTolObjects_DatumModifWithValue

  param theValue

  type theValue

  float

  rtype

  None

GetModifiers()

• Returns a sequence of modifiers of the datum.

  rtype

  XCAFDimTolObjects_DatumModifiersSequence

GetName()

• Returns datum name.

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetPlane()

• Returns annotation plane.

  rtype

  gp_Ax2

GetPoint()

• Gets point on the datum shape.

  rtype

  gp_Pnt

GetPointTextAttach()

• Gets datum text position.

  rtype

  gp_Pnt

GetPosition()

• Returns datum position in the related geometric tolerance object.

  rtype

  int

GetPresentation()

• Returns graphical presentation of the object.

  rtype

  TopoDS_Shape

GetPresentationName()

• Returns graphical presentation of the object.

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetSemanticName()

• Returns semantic name

  rtype

  opencascade::handle<TCollection_HAsciiString>

HasDatumTargetParams()

• Returns True if the datum has valid parameters for datum target (width, length, circle radius etc)

  rtype

  bool

HasPlane()

• Returns True if the datum has annotation plane.

  rtype

  bool

HasPoint()

• Returns True if point on the datum target is specified.

  rtype

  bool

HasPointText()

• Returns True if the datum text position is specified.

  rtype

  bool

IsDatumTarget()

• Returns True if the datum target is specified.

  rtype

  bool* Sets or drops the datum target indicator.

  param theIsDT

  type theIsDT

  bool

  rtype

  None

SetDatumTarget()

• Sets datum target shape.

  param theShape

  type theShape

  TopoDS_Shape

  rtype

  None

SetDatumTargetAxis()

• Sets datum target axis.

  param theAxis

  type theAxis

  gp_Ax2

  rtype

  None

SetDatumTargetLength()

• Sets datum target length.

  param theLength

  type theLength

  float

  rtype

  None

SetDatumTargetNumber()

• Sets datum target number.

  param theNumber

  type theNumber

  int

  rtype

  None

SetDatumTargetType()

• Sets datum target to point, line, rectangle, circle or area type.

  param theType

  type theType

  XCAFDimTolObjects_DatumTargetType

  rtype

  None

SetDatumTargetWidth()

• Sets datum target width.

  param theWidth

  type theWidth

  float

  rtype

  None

SetModifierWithValue()

• Sets datum modifier with value.

  param theModifier

  type theModifier

  XCAFDimTolObjects_DatumModifWithValue

  param theValue

  type theValue

  float

  rtype

  None

SetModifiers()

• Sets new sequence of datum modifiers.

  param theModifiers

  type theModifiers

  XCAFDimTolObjects_DatumModifiersSequence

  rtype

  None

SetName()

• Sets datum name.

  param theTag

  type theTag

  TCollection_HAsciiString

  rtype

  None

SetPlane()

• Sets annotation plane.

  param thePlane

  type thePlane

  gp_Ax2

  rtype

  None

SetPoint()

• Sets a point on the datum target shape.

  param thePnt

  type thePnt

  gp_Pnt

  rtype

  None

SetPointTextAttach()

• Sets a position of the datum text.

  param thePntText

  type thePntText

  gp_Pnt

  rtype

  None

SetPosition()

• Sets datum position in the related geometric tolerance object.

  param thePosition

  type thePosition

  int

  rtype

  None

SetPresentation()

• Set graphical presentation for object.

  param thePresentation

  type thePresentation

  TopoDS_Shape

  param thePresentationName

  type thePresentationName

  TCollection_HAsciiString

  rtype

  None

SetSemanticName()

• Sets semantic name

  param theName

  type theName

  TCollection_HAsciiString

  rtype

  None

property thisown

The membership flag

class XCAFDimTolObjects_DatumObjectSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class XCAFDimTolObjects_DimensionModifiersSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class XCAFDimTolObjects_DimensionObject(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None:param theObj: :type theObj: XCAFDimTolObjects_DimensionObject :rtype: None

AddDescription()

• Add new description.

  param theDescription

  type theDescription

  TCollection_HAsciiString

  param theName

  type theName

  TCollection_HAsciiString

  rtype

  None

AddModifier()

• Adds a modifier to the dimension sequence of modifiers.

  param theModifier

  type theModifier

  XCAFDimTolObjects_DimensionModif

  rtype

  None

static DownCast(t)

GetClassOfTolerance()

• Retrieves tolerance class parameters of the dimension. Returns True if the dimension is toleranced.

  param theHole

  type theHole

  bool

  param theFormVariance

  type theFormVariance

  XCAFDimTolObjects_DimensionFormVariance

  param theGrade

  type theGrade

  XCAFDimTolObjects_DimensionGrade

  rtype

  bool

GetDescription()

• Returns description with the given number.

  param theNumber

  type theNumber

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetDescriptionName()

• Returns name of description with the given number.

  param theNumber

  type theNumber

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetDirection()

• Returns the orientation of the dimension in annotation plane.

  param theDir

  type theDir

  gp_Dir

  rtype

  bool

GetLowerBound()

• Returns the lower bound of the range dimension, otherwise - zero.

  rtype

  float

GetLowerTolValue()

• Returns the upper value of the toleranced dimension, otherwise - zero.

  rtype

  float

GetModifiers()

• Returns a sequence of modifiers of the dimension.

  rtype

  XCAFDimTolObjects_DimensionModifiersSequence

GetNbOfDecimalPlaces()

• Returns the number of places to the left and right of the decimal point respectively.

  param theL

  type theL

  int

  param theR

  type theR

  int

  rtype

  None

GetPath()

• Returns a ‘curve’ along which the dimension is measured.

  rtype

  TopoDS_Edge

GetPlane()

• Returns annotation plane.

  rtype

  gp_Ax2

GetPoint()

• Get connection point (for dimesional_size), Get connection point for the first shape (for dimensional_location).

  rtype

  gp_Pnt

GetPoint2()

Return type

gp_Pnt

GetPointTextAttach()

• Returns position of the dimension text.

  rtype

  gp_Pnt

GetPresentation()

• Returns graphical presentation of the object.

  rtype

  TopoDS_Shape

GetPresentationName()

• Returns graphical presentation of the object

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetQualifier()

• Returns dimension qualifier.

  rtype

  XCAFDimTolObjects_DimensionQualifier

GetSemanticName()

• Returns semantic name

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetType()

• Returns dimension type.

  rtype

  XCAFDimTolObjects_DimensionType

GetUpperBound()

• Returns the upper bound of the range dimension, otherwise - zero.

  rtype

  float

GetUpperTolValue()

• Returns the lower value of the toleranced dimension, otherwise - zero.

  rtype

  float

GetValue()

• Returns the main dimension value. It will be the middle value in case of range dimension.

  rtype

  float

GetValues()

• Returns raw array of dimension values

  rtype

  opencascade::handle<TColStd_HArray1OfReal>

HasDescriptions()

• Returns true, if the object has descriptions.

  rtype

  bool

HasPlane()

• Returns True if the object has annotation plane.

  rtype

  bool

HasPoint()

• Returns true, if connection point exists (for dimesional_size), if connection point for the first shape exists (for dimensional_location).

  rtype

  bool

HasPoint2()

Return type

bool

HasQualifier()

• Returns True if the object has dimension qualifier.

  rtype

  bool

HasTextPoint()

• Returns True if the position of dimension text is specified.

  rtype

  bool

IsDimWithClassOfTolerance()

• Returns True if the form variance was set to not XCAFDimTolObjects_DimensionFormVariance_None value.

  rtype

  bool

IsDimWithPlusMinusTolerance()

• Returns True if the dimension is of +/- tolerance kind. Dimension is of +/- tolerance kind if its values array contains three elements defining the main value and the lower/upper tolerances.

  rtype

  bool

IsDimWithRange()

• Returns True if the dimension is of range kind. Dimension is of range kind if its values array contains two elements defining lower and upper bounds.

  rtype

  bool

NbDescriptions()

• Returns number of descriptions.

  rtype

  int

RemoveDescription()

• Remove description with the given number.

  param theNumber

  type theNumber

  int

  rtype

  None

SetClassOfTolerance()

• Sets tolerance class of the dimension. param theHole - True if the tolerance applies to an internal feature param theFormVariance - represents the fundamental deviation or ‘position letter’ of the ISO 286 limits-and-fits tolerance classification. param theGrade - represents the quality or the accuracy grade of a tolerance.

  param theHole

  type theHole

  bool

  param theFormVariance

  type theFormVariance

  XCAFDimTolObjects_DimensionFormVariance

  param theGrade

  type theGrade

  XCAFDimTolObjects_DimensionGrade

  rtype

  None

SetDirection()

• Sets an orientation of the dimension in annotation plane.

  param theDir

  type theDir

  gp_Dir

  rtype

  bool

SetLowerBound()

• Sets the lower bound of the range dimension, otherwise resets it to an empty range with the specified lower bound.

  param theLowerBound

  type theLowerBound

  float

  rtype

  None

SetLowerTolValue()

• Sets the lower value of the toleranced dimension, otherwise resets a simple dimension to toleranced one with the specified lower/upper tolerances. Returns False in case of range dimension.

  param theLowerTolValue

  type theLowerTolValue

  float

  rtype

  bool

SetModifiers()

• Sets new sequence of dimension modifiers.

  param theModifiers

  type theModifiers

  XCAFDimTolObjects_DimensionModifiersSequence

  rtype

  None

SetNbOfDecimalPlaces()

• Sets the number of places to the left and right of the decimal point respectively.

  param theL

  type theL

  int

  param theR

  type theR

  int

  rtype

  None

SetPath()

• Sets a ‘curve’ along which the dimension is measured.

  param thePath

  type thePath

  TopoDS_Edge

  rtype

  None

SetPlane()

• Sets annotation plane.

  param thePlane

  type thePlane

  gp_Ax2

  rtype

  None

SetPoint()

• Set connection point (for dimesional_size), Set connection point for the first shape (for dimensional_location).

  param thePnt

  type thePnt

  gp_Pnt

  rtype

  None

SetPoint2()

Parameters

thePnt –

type thePnt

gp_Pnt

rtype

None

SetPointTextAttach()

• Sets position of the dimension text.

  param thePntText

  type thePntText

  gp_Pnt

  rtype

  None

SetPresentation()

• Set graphical presentation for the object.

  param thePresentation

  type thePresentation

  TopoDS_Shape

  param thePresentationName

  type thePresentationName

  TCollection_HAsciiString

  rtype

  None

SetQualifier()

• Sets dimension qualifier as min., max. or average.

  param theQualifier

  type theQualifier

  XCAFDimTolObjects_DimensionQualifier

  rtype

  None

SetSemanticName()

• Sets semantic name

  param theName

  type theName

  TCollection_HAsciiString

  rtype

  None

SetType()

• Sets a specific type of dimension.

  param theTyupe

  type theTyupe

  XCAFDimTolObjects_DimensionType

  rtype

  None

SetUpperBound()

• Sets the upper bound of the range dimension, otherwise resets it to an empty range with the specified upper bound.

  param theUpperBound

  type theUpperBound

  float

  rtype

  None

SetUpperTolValue()

• Sets the upper value of the toleranced dimension, otherwise resets a simple dimension to toleranced one with the specified lower/upper tolerances. Returns False in case of range dimension.

  param theUperTolValue

  type theUperTolValue

  float

  rtype

  bool

SetValue()

• Sets the main dimension value. Overwrites previous values.

  param theValue

  type theValue

  float

  rtype

  None

SetValues()

• Replaces current raw array of dimension values with theValues array.

  param theValue

  type theValue

  TColStd_HArray1OfReal

  rtype

  None

property thisown

The membership flag

class XCAFDimTolObjects_DimensionObjectSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class XCAFDimTolObjects_GeomToleranceModifiersSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class XCAFDimTolObjects_GeomToleranceObject(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None:param theObj: :type theObj: XCAFDimTolObjects_GeomToleranceObject :rtype: None

AddModifier()

• Adds a tolerance modifier to the sequence of modifiers.

  param theModifier

  type theModifier

  XCAFDimTolObjects_GeomToleranceModif

  rtype

  None

static DownCast(t)

GetAffectedPlane()

• Returns affected plane.

  rtype

  gp_Pln

GetAffectedPlaneType()

Return type

XCAFDimTolObjects_ToleranceZoneAffectedPlane

GetAxis()

Return type

gp_Ax2

GetMaterialRequirementModifier()

• Returns material requirement of the tolerance.

  rtype

  XCAFDimTolObjects_GeomToleranceMatReqModif

GetMaxValueModifier()

• Returns the maximal upper tolerance.

  rtype

  float

GetModifiers()

• Returns a sequence of modifiers of the tolerance.

  rtype

  XCAFDimTolObjects_GeomToleranceModifiersSequence

GetPlane()

• Returns annotation plane.

  rtype

  gp_Ax2

GetPoint()

• Returns reference point.

  rtype

  gp_Pnt

GetPointTextAttach()

• Returns the text position.

  rtype

  gp_Pnt

GetPresentation()

• Returns graphical presentation of the object.

  rtype

  TopoDS_Shape

GetPresentationName()

• Returns graphical presentation of the object.

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetSemanticName()

• Returns semantic name

  rtype

  opencascade::handle<TCollection_HAsciiString>

GetType()

• Returns type of the object.

  rtype

  XCAFDimTolObjects_GeomToleranceType

GetTypeOfValue()

• Returns type of tolerance value.

  rtype

  XCAFDimTolObjects_GeomToleranceTypeValue

GetValue()

• Returns tolerance value.

  rtype

  float

GetValueOfZoneModifier()

• Returns value associated with tolerance zone.

  rtype

  float

GetZoneModifier()

• Returns tolerance zone.

  rtype

  XCAFDimTolObjects_GeomToleranceZoneModif

HasAffectedPlane()

Return type

bool

HasAxis()

Return type

bool

HasPlane()

• Returns True if the object has annotation plane.

  rtype

  bool

HasPoint()

• Returns True if reference point is specified.

  rtype

  bool

HasPointText()

• Returns True if text position is specified.

  rtype

  bool

SetAffectedPlane()

• Sets affected plane.

  param thePlane

  type thePlane

  gp_Pln

  rtype

  None* Sets affected plane.

  param thePlane

  type thePlane

  gp_Pln

  param theType

  type theType

  XCAFDimTolObjects_ToleranceZoneAffectedPlane

  rtype

  None

SetAffectedPlaneType()

Parameters

theType –

type theType

XCAFDimTolObjects_ToleranceZoneAffectedPlane

rtype

None

SetAxis()

Parameters

theAxis –

type theAxis

gp_Ax2

rtype

None

SetMaterialRequirementModifier()

• Sets material requirement of the tolerance.

  param theMatReqModif

  type theMatReqModif

  XCAFDimTolObjects_GeomToleranceMatReqModif

  rtype

  None

SetMaxValueModifier()

• Sets the maximal upper tolerance value for tolerance with modifiers.

  param theModifier

  type theModifier

  float

  rtype

  None

SetModifiers()

• Sets new sequence of tolerance modifiers.

  param theModifiers

  type theModifiers

  XCAFDimTolObjects_GeomToleranceModifiersSequence

  rtype

  None

SetPlane()

• Sets annotation plane.

  param thePlane

  type thePlane

  gp_Ax2

  rtype

  None

SetPoint()

• Sets reference point.

  param thePnt

  type thePnt

  gp_Pnt

  rtype

  None

SetPointTextAttach()

• Sets text position.

  param thePntText

  type thePntText

  gp_Pnt

  rtype

  None

SetPresentation()

• Set graphical presentation for object.

  param thePresentation

  type thePresentation

  TopoDS_Shape

  param thePresentationName

  type thePresentationName

  TCollection_HAsciiString

  rtype

  None

SetSemanticName()

• Sets semantic name

  param theName

  type theName

  TCollection_HAsciiString

  rtype

  None

SetType()

• Sets type of the object.

  param theType

  type theType

  XCAFDimTolObjects_GeomToleranceType

  rtype

  None

SetTypeOfValue()

• Sets type of tolerance value.

  param theTypeOfValue

  type theTypeOfValue

  XCAFDimTolObjects_GeomToleranceTypeValue

  rtype

  None

SetValue()

• Sets tolerance value.

  param theValue

  type theValue

  float

  rtype

  None

SetValueOfZoneModifier()

• Sets value associated with tolerance zone.

  param theValue

  type theValue

  float

  rtype

  None

SetZoneModifier()

• Sets tolerance zone.

  param theZoneModif

  type theZoneModif

  XCAFDimTolObjects_GeomToleranceZoneModif

  rtype

  None

property thisown

The membership flag

class XCAFDimTolObjects_GeomToleranceObjectSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class XCAFDimTolObjects_Tool(*args)

Bases: object

Parameters

theDoc –

type theDoc

TDocStd_Document

rtype

None

GetDimensions()

• Returns a sequence of Dimensions currently stored in the GD&T table

  param theDimensionObjectSequence

  type theDimensionObjectSequence

  XCAFDimTolObjects_DimensionObjectSequence

  rtype

  None

GetGeomTolerances()

• Returns a sequence of Tolerances currently stored in the GD&T table

  param theGeomToleranceObjectSequence

  type theGeomToleranceObjectSequence

  XCAFDimTolObjects_GeomToleranceObjectSequence

  param theDatumObjectSequence

  type theDatumObjectSequence

  XCAFDimTolObjects_DatumObjectSequence

  param theMap

  type theMap

  XCAFDimTolObjects_DataMapOfToleranceDatum

  rtype

  None

GetRefDatum()

• Returns DatumObject defined for Shape

  param theShape

  type theShape

  TopoDS_Shape

  param theDatum

  type theDatum

  XCAFDimTolObjects_DatumObject

  rtype

  bool

GetRefDimensions()

• Returns all Dimensions defined for Shape

  param theShape

  type theShape

  TopoDS_Shape

  param theDimensions

  type theDimensions

  XCAFDimTolObjects_DimensionObjectSequence

  rtype

  bool

GetRefGeomTolerances()

• Returns all GeomTolerances defined for Shape

  param theShape

  type theShape

  TopoDS_Shape

  param theGeomToleranceObjectSequence

  type theGeomToleranceObjectSequence

  XCAFDimTolObjects_GeomToleranceObjectSequence

  param theDatumObjectSequence

  type theDatumObjectSequence

  XCAFDimTolObjects_DatumObjectSequence

  param theMap

  type theMap

  XCAFDimTolObjects_DataMapOfToleranceDatum

  rtype

  bool

property thisown

The membership flag