pycatia.hybrid_shape_interfaces.hybrid_shape_assemble

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

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.hybrid_shape_interfaces.hybrid_shape_assemble.HybridShapeAssemble(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.HybridShape
HybridShapeAssemble

Represents the hybrid shape assemble feature object.
Role: To access the data of the hybrid shape assemble feature object. This data
includes:

A list of the assembled elements
Some methods to access this data

Use the CATIAHybridShapeFactory to create a HybridShapeAssemble
object.

See also:
HybridShapeFactory
add_element(i_element: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddElement(Reference iElement)

Adds an element to the hybrid shape assemble feature
object.

Parameters:

iElement
The element to add to the hybrid shape assemble feature
object.
Sub-element(s) supported (see

Boundary object): Face, TriDimFeatEdge and BiDimFeatEdge.


Examples:
The following example adds the iElement feature object to the
HybridShapeAssemble object.

HybridShapeAssemble.AddElement iElement
Parameters:

i_element (Reference) –

Return type:

None

add_sub_element(i_sub_element: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddSubElement(Reference iSubElement)

Adds a sub element to the hybrid shape assemble feature
object.

Parameters:

iSubElement
The sub element to remove to the hybrid shape assemble feature
object.
Parameters:

i_sub_element (Reference) –

Return type:

None

append_federated_element(i_element: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AppendFederatedElement(Reference iElement)

Appends an init to the list of elements to federate.

Parameters:

iElement
Element to append.

See also:
Reference
Parameters:

i_element (Reference) –

Return type:

None

get_angular_tolerance() → float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetAngularTolerance() As double

Get the angular tolerance.

Parameters:

oValue
The angular tolerance.
Return type:

float

get_angular_tolerance_mode() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetAngularToleranceMode() As boolean

Get the angular tolerance mode.

Parameters:

oValue
The angular tolerance mode.
Return type:

bool

get_connex() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetConnex() As boolean

Get the connex checker flag.

Parameters:

oConnex
Return type:

bool

get_deviation() → float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetDeviation() As double

Get the deviation value.

Parameters:

odeviation
The deviation.
Return type:

float

get_element(i_rank: int) → Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetElement(long iRank) As Reference

Retrieves an element used by the hybrid shape assemble feature
object.

Parameters:

iRank
The rank of the element to read.

Examples:
The following example gets the oElement feature object of the
HybridShapeAssemble object at the position iRank.

Dim oElement As Reference
Set oElement = HybridShapeAssemble.GetElement (iRank).
Parameters:

i_rank (int) –

Return type:

Reference

get_elements_size() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetElementsSize() As long

Returns the size of the list of elements to assemble in the hybrid shape
assemble feature object.

Parameters:

oSize
Number of elements in the Assemble.

Example:
This example retrieves the number of elements in the
HybShpAssemble hybrid shape assemble.

Dim oSize As long
oSize = HybShpAssemble.GetElementsSize
Return type:

int

get_federated_element(i_rank: int) → Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetFederatedElement(long iRank) As Reference

Retrieves an federated inits used by the hybrid shape assemble feature
object.

Parameters:

iRank
The rank of the element to read.
oElement
The federated element.

See also:
Reference
Parameters:

i_rank (int) –

Return type:

Reference

get_federated_elements_size() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetFederatedElementsSize() As long

Gets the number of federated inits.

Parameters:

Size
Number of elements.
Return type:

int

get_federation_propagation() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetFederationPropagation() As long

Gets the propagation mode of the federation.

Parameters:

i
type of propagation (0: No, 1: All, 2: Continuity,
3:Tangency).
Return type:

int

get_manifold() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetManifold() As boolean

Get the manifold checker flag.

Parameters:

oManifold
Return type:

bool

get_simplify() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetSimplify() As boolean

Get the simplify flag.

Parameters:

oSimplify
Return type:

bool

get_sub_element(i_rank: int) → Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetSubElement(long iRank) As Reference

Retrieves a sub element used by the hybrid shape assemble feature
object.

Parameters:

iRank
The rank of the subelement to read.
Parameters:

i_rank (int) –

Return type:

Reference

get_sub_elements_size() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetSubElementsSize() As long

Returns the size of the list of sub-elements to remove in the hybrid shape
assemble feature object.

Parameters:

oSize
Number of sub elements in the Assemble.

Example:
This example retrieves the number of sub elements in the
HybShpAssemble hybrid shape assemble.

Dim oSize As long
oSize = HybShpAssemble.GetSubElementsSize
Return type:

int

get_suppress_mode() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetSuppressMode() As boolean

Get the SuppressMode flag.

Parameters:

oSuppressMode
Return type:

bool

get_tangency_continuity() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetTangencyContinuity() As boolean

Get the tangency continuity checker flag.

Parameters:

oTangencyContinuity
Return type:

bool

property invert: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Invert() As boolean

Returns or sets the invert mode.
Legal values: True the result is inverted. False the result is not
inverted.

Example:

This example sets the invert mode of
the HybShpAssemble hybrid shape assemble feature to
True.


HybShpAssemble.Invert = True
Return type:

bool

remove_element(i_rank: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveElement(long iRank)

Removes an element used by the hybrid shape assemble feature
object.

Parameters:

iRank
The rank of the element to remove.

Examples:
The following example removes the feature object from the
HybridShapeAssemble object at the position iRank.

HybridShapeAssemble.RemoveElement iRank.
Parameters:

i_rank (int) –

Return type:

None

remove_federated_element(i_rank: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveFederatedElement(long iRank)

Removes an element to the list of elements to federate.

Parameters:

iRank
Position of the element to remove.
Parameters:

i_rank (int) –

Return type:

None

remove_sub_element(i_rank: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveSubElement(long iRank)

Removes a sub element used by the hybrid shape assemble feature
object.

Parameters:

iRank
The rank of the element to remove.
Parameters:

i_rank (int) –

Return type:

None

replace_element(i_pos: int, i_element: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ReplaceElement(long iPos,
Reference iElement)

Replaces the element at specified position in the hybrid shape assemble
feature object.

Parameters:

iPos
Position at which the element should be replaced.
iElement
Reference of the element to be inserted.

Example:
This example replaces the element in the HybShpAssemble
assemble feature at specified position iPos

HybShpAssemble.ReplaceElement iPos,iElement
Parameters:
Return type:

None

set_angular_tolerance(i_value: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetAngularTolerance(double iValue)

Set the angular tolerance.

Parameters:

iValue
The angular tolerance.
Parameters:

i_value (float) –

Return type:

None

set_angular_tolerance_mode(i_value: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetAngularToleranceMode(boolean iValue)

Set the angular tolerance mode.

Parameters:

iValue
The angular tolerance mode.
Parameters:

i_value (bool) –

Return type:

None

set_connex(i_connex: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetConnex(boolean iConnex)

Set the connex checker flag.

Parameters:

iConnex
Parameters:

i_connex (bool) –

Return type:

None

set_deviation(ideviation: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDeviation(double ideviation)

Set the deviation value.

Parameters:

ideviation
The deviation.
Parameters:

ideviation (float) –

Return type:

None

set_federation_propagation(i_mode: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetFederationPropagation(long iMode)

Sets the propagation mode of federation.

Parameters:

i
type of propagation (0: No, 1: All, 2: Continuity,
3:Tangency).
Parameters:

i_mode (int) –

Return type:

None

set_manifold(i_manifold: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetManifold(boolean iManifold)

Set the manifold checker flag.

Parameters:

iManifold
Parameters:

i_manifold (bool) –

Return type:

None

set_simplify(i_simplify: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetSimplify(boolean iSimplify)

Set the simplify flag.

Parameters:

iSimplify
Parameters:

i_simplify (bool) –

Return type:

None

set_suppress_mode(i_suppress_mode: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetSuppressMode(boolean iSuppressMode)

Set the SuppressMode flag.

Parameters:

iSuppressMode
Parameters:

i_suppress_mode (bool) –

Return type:

None

set_tangency_continuity(i_tangency_continuity: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTangencyContinuity(boolean iTangencyContinuity)

Set the tangency continuity checker flag.

Parameters:

iTangencyContinuity
Parameters:

i_tangency_continuity (bool) –

Return type:

None