pycatia.cat_str_functional_interfaces.sfm_factory

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_str_functional_interfaces.sfm_factory.SFMFactory(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
MecModInterfaces.Factory
SfmFactory

Interface to create Structure Functional Modeler Objects.
Role: To create the structure object such as SuperPlate, Stiffener,
StiffenerOnFreeEdge, Beam, Opening and Connection.
add_adv_super_plate(i_category: str, i_support: Reference, i_destination: Reference) → SFMSuperPlate

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddAdvSuperPlate(CATBSTR iCategory,
Reference iSupport,
Reference iDestination) As SfmSuperPlate

Creates an advanced SuperPlate.
Role: Allows creating an advanced SuperPlate, ie with the concave limit
mode.

Parameters:

iCategory
[in] Category.
iSupport
[in] Support surface.
iDestination
[in] SuperPlate’s destination.
oSuperPlate
[out] SuperPlate.

Returns:
S_OK if everything ran ok.
See also:
SfmSuperPlate
Parameters:
Return type:

SFMSuperPlate

add_member_beams_and_plane(i_category: str, i_section_name: str, i_member1: SFMMember, i_member2: SFMMember, i_ref_plane: Reference, i_destination: Reference) → SFMMemberPlane2Curves

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberBeamsAndPlane(CATBSTR iCategory,
CATBSTR iSectionName,
SfmMember iMember1,
SfmMember iMember2,
Reference iRefPlane,
Reference iDestination) As SfmMemberPlane2Curves

Creates a Member between two existing members using Plane.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iMember1
[in] First Member.
iMember1
[in] Second Member.
iRefPlane
[in] Plane
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
CATIASfmMemberPlane2Members
Parameters:
Return type:

SFMMemberPlane2Curves

add_member_crv(i_category: str, i_section_name: str, i_curve: Reference, i_destination: Reference) → SFMMemberCurve

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberCrv(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iCurve,
Reference iDestination) As SfmMemberCurve

Creates a SuperMember on a curve.
Role: Allows creating a member on a curve.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iCurve
[in] Curve.
Sub-element(s) supported (see

Boundary object):
iDestination
[in] Member’s destination.
oMember
[out] Member.
Returns:
S_OK if everything ran ok.
See also:
SfmMemberCurve
Parameters:

  • i_category (str) –

  • i_section_name (str) –

  • i_curve (Reference) –

  • i_destination (Reference) –

Return type:

SFMMemberCurve

add_member_crv_on_ref(i_category: str, i_section_name: str, i_curve: Reference, i_reference: Reference, i_destination: Reference) → SFMMemberCurve

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberCrvOnRef(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iCurve,
Reference iReference,
Reference iDestination) As SfmMemberCurve

Creates a SuperMember on a curve and on a reference
surface.
Role: Allows creating a member on a curve, perpendicular to a reference
surface.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iCurve
[in] Curve.
Sub-element(s) supported (see

Boundary object):
iReference
[in] Surface on which the curve must lay down.
iDestination
[in] Member’s destination.
oMember
[out] Member.
Returns:
S_OK if everything ran ok.
See also:
SfmMemberCurve
Parameters:
Return type:

SFMMemberCurve

add_member_pt_length(i_category: str, i_section_name: str, i_point: Reference, i_direction: Reference, i_length: float, i_destination: Reference) → SFMMemberPointLength

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberPtLength(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iPoint,
Reference iDirection,
double iLength,
Reference iDestination) As SfmMemberPointLength

Creates a straight SuperMember defined by a point, a direction and a
length.
Role: Allows creating a member defined by a point, a direction and a
length.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iPoint
[in] Point.
iDirection
[in] Direction element: it can be a line or a plane.

iLength
[in] Length.
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMemberPointLength
Parameters:

  • i_category (str) –

  • i_section_name (str) –

  • i_point (Reference) –

  • i_direction (Reference) –

  • i_length (float) –

  • i_destination (Reference) –

Return type:

SFMMemberPointLength

add_member_pt_on_crv_pt(i_category: str, i_section_name: str, i_curve1: Reference, i_ratio_mode1: bool, i_offset1: float, i_point2: Reference, i_destination: Reference) → SFMMember2Points

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberPtOnCrvPt(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iCurve1,
boolean iRatioMode1,
double iOffset1,
Reference iPoint2,
Reference iDestination) As SfmMember2Points

Creates a straight SuperMember between a point on curve and a
point.
Role: Allows creating a member between a point on curve and a
point.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iCurve1
[in] Curve.
iRatioMode1
[in] If true then Ratio, if false then Length mode for the point on
curve.
iOffset1
[in] Offset.
iPoint2
[in] Point.
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMember2Points
Parameters:

  • i_category (str) –

  • i_section_name (str) –

  • i_curve1 (Reference) –

  • i_ratio_mode1 (bool) –

  • i_offset1 (float) –

  • i_point2 (Reference) –

  • i_destination (Reference) –

Return type:

SFMMember2Points

add_member_pt_on_crv_pt_on_crv(i_category: str, i_section_name: str, i_curve1: Reference, i_ratio_mode1: bool, i_offset1: float, i_curve2: Reference, i_ratio_mode2: bool, i_offset2: float, i_destination: Reference) → SFMMember2Points

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberPtOnCrvPtOnCrv(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iCurve1,
boolean iRatioMode1,
double iOffset1,
Reference iCurve2,
boolean iRatioMode2,
double iOffset2,
Reference iDestination) As SfmMember2Points

Creates a straight SuperMember between two points on
curve.
Role: Allows creating a member between two points on
curve.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iCurve1
[in] Curve.
iRatioMode1
[in] If true then Ratio, if false then Length mode for the point on
curve.
iOffset1
[in] Offset.
iCurve2
[in] Curve.
iRatioMode2
[in] If true then Ratio, if false then Length mode for the point on
curve.
iOffset2
[in] Offset.
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMember2Points
Parameters:

  • i_category (str) –

  • i_section_name (str) –

  • i_curve1 (Reference) –

  • i_ratio_mode1 (bool) –

  • i_offset1 (float) –

  • i_curve2 (Reference) –

  • i_ratio_mode2 (bool) –

  • i_offset2 (float) –

  • i_destination (Reference) –

Return type:

SFMMember2Points

add_member_pt_pt(i_category: str, i_section_name: str, i_point1: Reference, i_point2: Reference, i_destination: Reference) → SFMMember2Points

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberPtPt(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iPoint1,
Reference iPoint2,
Reference iDestination) As SfmMember2Points

Creates a straight SuperMember between two points.
Role: Allows creating a member between two points.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iPoint1
[in] Point.
iPoint2
[in] Point.
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMember2Points
Parameters:
Return type:

SFMMember2Points

add_member_pt_pt_on_crv(i_category: str, i_section_name: str, i_point1: Reference, i_curve2: Reference, i_ratio_mode2: bool, i_offset2: float, i_destination: Reference) → SFMMember2Points

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberPtPtOnCrv(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iPoint1,
Reference iCurve2,
boolean iRatioMode2,
double iOffset2,
Reference iDestination) As SfmMember2Points

Creates a straight SuperMember between a point and a point on
curve.
Role: Allows creating a member between a point and a point on
curve.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iPoint1
[in] Point.
iCurve2
[in] Curve.
iRatioMode2
[in] If true then Ratio, if false then Length mode for the point on
curve.
iOffset2
[in] Offset.
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMember2Points
Parameters:

  • i_category (str) –

  • i_section_name (str) –

  • i_point1 (Reference) –

  • i_curve2 (Reference) –

  • i_ratio_mode2 (bool) –

  • i_offset2 (float) –

  • i_destination (Reference) –

Return type:

SFMMember2Points

add_member_pt_up_to_limit(i_category: str, i_section_name: str, i_point: Reference, i_direction: Reference, i_limit: Reference, i_destination: Reference) → SFMMemberPointUpToLimit

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberPtUpToLimit(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iPoint,
Reference iDirection,
Reference iLimit,
Reference iDestination) As SfmMemberPointUpToLimit

Creates a straight member defined by a point, a direction and a
limit.
Role: Allows creating a member defined by a point, a direction and a
limit.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iPoint
[in] Point.
iDirection
[in] Direction element: it can be a line or a plane.

iLimit
[in] Limit: it can be any kind of geometric element.

iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMemberPointUpToLimit
Parameters:
Return type:

SFMMemberPointUpToLimit

add_member_surf_surf(i_category: str, i_section_name: str, i_surface1: Reference, i_surface2: Reference, i_destination: Reference) → SFMMemberSurfSurf

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddMemberSurfSurf(CATBSTR iCategory,
CATBSTR iSectionName,
Reference iSurface1,
Reference iSurface2,
Reference iDestination) As SfmMemberSurfSurf

Creates a SuperMember by the intersection of two surfaces.
Role: Allows creating a member by the intersection of two
surfaces.

Parameters:

iCategory
[in] Member’s category.
iSectionName
[in] Name of the section.
iSurface1
[in] First surface.
iSurface2
[in] Second surface.
iDestination
[in] Member’s destination.
oMember
[out] Member.

Returns:
S_OK if everything ran ok.
See also:
SfmMemberSurfSurf
Parameters:
Return type:

SFMMemberSurfSurf

add_super_plate(i_category: str, i_support: Reference, i_destination: Reference) → SFMSuperPlate

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddSuperPlate(CATBSTR iCategory,
Reference iSupport,
Reference iDestination) As SfmSuperPlate

Creates a SuperPlate.
Role: Allows creating a SuperPlate in the regular limit mode (split
mode).

Parameters:

iCategory
[in] Category.
iSupport
[in] Support surface.
iDestination
[in] SuperPlate’s destination.
oSuperPlate
[out] SuperPlate.

Returns:
S_OK if everything ran ok.
See also:
SfmSuperPlate
Parameters:
Return type:

SFMSuperPlate

add_super_stiffener(i_category: str, i_section_name: str, i_super_plate: SFMSuperPlate, i_web_support: Reference) → SFMStiffener

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddSuperStiffener(CATBSTR iCategory,
CATBSTR iSectionName,
SfmSuperPlate iSuperPlate,
Reference iWebSupport) As SfmStiffener

Creates a SuperStiffener.
Role: Allows creating a SuperStiffener in the normal to plate mode with the
WebSideLeft anchor point.

Parameters:

iCategory
[in] Category.
iSectionName
[in] Section name.
iSuperPlate
[in] SuperPlate to be stiffened.
oSuperStiffener
[out] SuperStiffener.

Returns:
S_OK if everything ran ok.
See also:
SfmStiffener
Parameters:

  • i_category (str) –

  • i_section_name (str) –

  • i_super_plate (SFMSuperPlate) –

  • i_web_support (Reference) –

Return type:

SFMStiffener

add_super_stiffener_on_free_edge(i_category: str, i_section_name: str, i_super_plate: SFMSuperPlate, i_free_edge: Reference) → SFMStiffenerOnFreeEdge

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddSuperStiffenerOnFreeEdge(CATBSTR iCategory,
CATBSTR iSectionName,
SfmSuperPlate iSuperPlate,
Reference iFreeEdge) As SfmStiffenerOnFreeEdge

Creates a SuperStiffener on Free Edge.
Role: Allows creating a SuperStiffener on Free Edge in the normal to plate
mode with the WebSideLeft anchor point.

Parameters:

iCategory
[in] Category.
iSectionName
[in] Section name.
iSuperPlate
[in] SuperPlate to be stiffened.
iFreeEdge
[in] Support to be used for creating SFE.
oSuperStiffenerOnFreeEdge
[out] SuperStiffener on free edge.

Returns:
S_OK if everything ran ok.
See also:
SfmStiffenerOnFreeEdge
Parameters:
Return type:

SFMStiffenerOnFreeEdge

get_manager() → SFMManager

Note

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

Retrieved the services manager.
Role: Allows getting the services manager.

Returns:
S_OK if everything ran ok.
See also:
SfmManager
Return type:

SFMManager