pycatia.cat_sch_platform_interfaces.sch_grr_zone

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_sch_platform_interfaces.sch_grr_zone.SchGRRZone(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
SchGRRZone

Manage the graphical representation of a schematic zone.
add_boundary_element(i_zone_bndy_to_add: SchBoundaryElem) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddBoundaryElement(SchBoundaryElem iZoneBndyToAdd)

Add a boundary element to the zone.

Parameters:

iZoneBndy
The geometric boundary elements to be added.

Example:

Dim objThisIntf As SchGRRZone
Dim objArg1 As SchBoundaryElem
…
objThisIntf.AddBoundaryElementobjArg1
Parameters:

i_zone_bndy_to_add (SchBoundaryElem) –

Return type:

None

is_boundary_valid(b_is_valid: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub IsBoundaryValid(boolean BIsValid)

Check whether the boundary of this zone graphical representation is
valid.

Parameters:

oLZoneBndy
Set to TRUE if the boundary is a closed polygon

Example:

Dim objThisIntf As SchGRRZone
Dim bVar1 As boolean
…
objThisIntf.IsBoundaryValidbVar1
Parameters:

b_is_valid (bool) –

Return type:

None

list_boundary_elements() → SchListOfObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListBoundaryElements() As SchListOfObjects

List all boundary elements of this zone graphical
representation.

Parameters:

oLZoneBndy
List of geometric boundaries of this zone graphical representation


Example:



Dim objThisIntf As SchGRRZone
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListBoundaryElements
Return type:

SchListOfObjects

remove_boundary_element(i_zone_bndy_to_remove: SchBoundaryElem) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RemoveBoundaryElement(SchBoundaryElem
iZoneBndyToRemove)

Remove a boundary element to the zone.

Parameters:

iZoneBndy
The geometric boundary elements to be added.

Example:

Dim objThisIntf As SchGRRZone
Dim objArg1 As SchBoundaryElem
…
objThisIntf.RemoveBoundaryElementobjArg1
Parameters:

i_zone_bndy_to_remove (SchBoundaryElem) –

Return type:

None