pycatia.cat_tps_interfaces.semantic_gdt

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_tps_interfaces.semantic_gdt.SemanticGDT(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

SemanticGDT

Interface managing Semantic GDT.

associated_ref_frame() → AssociatedRefFrame

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func AssociatedRefFrame() As AssociatedRefFrame

Returns the annotation on the AssociatedRefFrame

interface.

Parameters:

oAssRefFra

The AssociatedRefFrame.

Return type:

AssociatedRefFrame

composite_tolerance() → CompositeTolerance

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func CompositeTolerance() As CompositeTolerance

Returns the CompositeTolerance interface.

Parameters:

oCompTol

The CompositeTolerance.

Return type:

CompositeTolerance

frame_extensions(i_frame_extent_index: int) → SemanticGDTFrameExtension

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func FrameExtensions(long iFrameExtentIndex) As

SemanticGDTFrameExtension

Role: Gets the Auxiliary Features at given Index applied on

GDT.

Parameters:

iFrameExtentIndex

Index of the Frame Extension to retrieve.

oAuxiliaryFeatures

The list of Auxiliary Features specified on GDT (implies ISO

Standard applied).

Parameters:

i_frame_extent_index (int) –

Return type:

SemanticGDTFrameExtension

free_state() → FreeState

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func FreeState() As FreeState

Returns the FreeState interface.

Parameters:

oFreeState

The FreeState.

Return type:

FreeState

has_a_centered_element() → bool

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func HasACenteredElement() As boolean

Role: Checks if the geometrical specification has a centered

element.

Precondition: Median Feature characteristics is valid only for ISO

standard

Parameters:

oHasCenterElt

TRUE: The GDT has a center element

FALSE: The GDT has not a center element or standard different

from ISO.

Return type:

bool

has_a_frame_extension() → int

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func HasAFrameExtension() As long

Role: Checks if the geometrical specification wears a frame extension

specification.

Precondition: Intersection Plane, Orientation Plane, Collection Plane or

Direction Feature are only meaningful in ISO Standard.

Parameters:

oFrameExtentNumber

Greater than 0: The GDT has oFrameExtentNumber frame

extensions

Equal or less than 0: The GDT has not a frame extension or

standard different from ISO (value is -1).

Return type:

int

has_a_free_state() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasAFreeState() As boolean

Checks if the GDT has a Free State.

Parameters:

oHasAFreeState

TRUE: There is a Free State

FALSE: There is no Free State

Return type:

bool

has_a_material_condition() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasAMaterialCondition() As boolean

Checks if the GDT has a Material Condition.

Parameters:

oHasMatCond

TRUE: A Material Condition exits

FALSE: There is no Material Condition

Return type:

bool

has_a_particular_tol_elem() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasAParticularTolElem() As boolean

Checks if the GDT has a Particuler Element.

Parameters:

oHasAParTolElem

TRUE: There is a Particuler Element

FALSE: There is no Particuler Element

Return type:

bool

has_a_tangent_plane() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasATangentPlane() As boolean

Checks if the GDT has a Tangent Plane Modifier.

Parameters:

oIsATangentPlane

TRUE: There has a Tangent Plane

FALSE: There has not Tangent Plane

Return type:

bool

has_a_tolerance_per_unit_basis_restrictive_value() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasATolerancePerUnitBasisRestrictiveValue() As boolean

Checks if the GDT has a Tolerance Per Unit Basis Restricted

Value.

Parameters:

oHasATolRes

TRUE: There is a Tolerance Per Unit Basis Restricted

Value

FALSE: There is no Tolerance Per Unit Basis Restricted

Value

Return type:

bool

is_a_composite_tolerance() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsACompositeTolerance() As boolean

Checks if the GDT is a Composite Tolerance.

Parameters:

oIsACompTol

TRUE: There is a Composite Tolerance

FALSE: There is no Composite Tolerance

Return type:

bool

is_a_projected_tolerance_zone() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsAProjectedToleranceZone() As boolean

Checks if the GDT is a Projected Zone.

Parameters:

oIsAProjTolZone

TRUE: There is a Projected Zone

FALSE: There is no Projected Zone

Return type:

bool

is_a_shifted_profile_tolerance() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsAShiftedProfileTolerance() As boolean

Checks if the GDT is a Shifted Profile Tolerance.

Parameters:

oIsAShiftProTol

TRUE: There is a Shifted Profile Tolerance

FALSE: There is no Shifted Profile Tolerance

Return type:

bool

is_a_tolerance_unit_basis_value() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsAToleranceUnitBasisValue() As boolean

Checks if the GDT is a Tolerance Unit Basis Value.

Parameters:

oIsATolUnitBas

TRUE: A Tolerance Zone exits

FALSE: There is no Tolerance Zone

Return type:

bool

is_a_tolerance_zone() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsAToleranceZone() As boolean

Checks if a Tolerance Zone exists.

Parameters:

oIsATolZone

TRUE: A Tolerance Zone exits

FALSE: There is no Tolerance Zone

Return type:

bool

is_an_associated_ref_frame() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsAnAssociatedRefFrame() As boolean

Checks if the GDT is an Associated Reference Frame.

Parameters:

oIsAnAssRefFra

TRUE: There is an Associated Reference Frame

FALSE: There is no Associated Reference Frame

Return type:

bool

is_applied_on_multiple_entities() → bool

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func IsAppliedOnMultipleEntities() As boolean

Role: Checks if the geometrical specification is applied onto multiple

geometries.

Parameters:

oIsAPattern

TRUE: The GDT is applied on Nx elements

FALSE: The GDT is applied on a unique surface.

Return type:

bool

material_condition() → MaterialCondition

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func MaterialCondition() As MaterialCondition

Returns the MaterialCondition interface.

Parameters:

oMatCond

The Material Condition.

Return type:

MaterialCondition

median_feature() → MedianFeature

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func MedianFeature() As MedianFeature

Role: Gets the GDT on the Median Feature interface.

Parameters:

oMedianFeat

The Median Feature.

Return type:

MedianFeature

nx_display() → SemanticGDTNxDisplay

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func NxDisplay() As SemanticGDTNxDisplay

Role: Gets the GDT on the handle to read Nx instance count, Collection or

Separate type of the geometrical specification.

Parameters:

oNxDisplay

Behavior to qualify Nx application context of this GDT.

Return type:

SemanticGDTNxDisplay

particular_tol_elem() → ParticularTolElem

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func ParticularTolElem() As ParticularTolElem

Returns the ParticularTolElem interface.

Parameters:

oParTolElem

The ParticularTolElem.

Return type:

ParticularTolElem

projected_tolerance_zone() → ProjectedToleranceZone

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func ProjectedToleranceZone() As ProjectedToleranceZone

Returrns the ProjectedToleranceZone interface.

Parameters:

oProjTolZone

The ProjectedToleranceZone.

Return type:

ProjectedToleranceZone

shifted_profile_tolerance() → ShiftedProfileTolerance

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func ShiftedProfileTolerance() As ShiftedProfileTolerance

Returns the ShiftedProfileTolerance interface.

Parameters:

oShiftProTol

The ShiftedProfileTolerance.

Return type:

ShiftedProfileTolerance

tangent_plane() → TangentPlane

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func TangentPlane() As TangentPlane

Returns the Tangent Plane interface.

Parameters:

oTangentPlane

The Tangent Plane.

Return type:

TangentPlane

tolerance_per_unit_basis_restrictive_value() → TolerancePerUnitBasisRestrictiveValue

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func TolerancePerUnitBasisRestrictiveValue() As

TolerancePerUnitBasisRestrictiveValue

Returns the TolerancePerUnitBasisRestrictiveValue

interface.

Parameters:

oTolRes

The TolerancePerUnitBasisRestrictiveValue.

Return type:

TolerancePerUnitBasisRestrictiveValue

tolerance_unit_basis_value() → ToleranceUnitBasisValue

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func ToleranceUnitBasisValue() As ToleranceUnitBasisValue

Returns the ToleranceUnitBasisValue interface.

Parameters:

oTolUnitBas

The Tolerance Unit Basis Value.

Return type:

ToleranceUnitBasisValue

tolerance_zone() → ToleranceZone

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func ToleranceZone() As ToleranceZone

Returns the ToleranceZone interface.

Parameters:

oTolZone

The Tolerance Zone.

Return type:

ToleranceZone

tps_parallel_on_screen() → TPSParallelOnScreen

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func TPSParallelOnScreen() As TPSParallelOnScreen

Gets the annotation on TPSParallelOnScreen interface.

Return type:

TPSParallelOnScreen