pycatia.threed_xml_interfaces.export_3d_xml_setting_att

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.threed_xml_interfaces.export_3d_xml_setting_att.Export3DXmlSettingAtt(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
System.SettingController
Export3DXmlSettingAtt

Represents a setting controller for the 3D XML export
settings.
Role: This interface is implemented by a component which represents the
controller of the 3D XML export settings.
property alternate_view: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AlternateView() As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.get_DesignReview Returns or sets the alternate view
activation flag.

Example:
This example activates the alternate view export.


export3DXmlSettingAtt.AlternateView = True
Return type:

bool

property animation: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Animation() As boolean

Returns or sets the animation activation flag.

Example:
This example activates the animation export.


export3DXmlSettingAtt.Animation = True
Return type:

bool

property annotated_view: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AnnotatedView() As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.get_DesignReview Returns or sets the annotated view
activation flag.

Example:
This example activates the annotated view export.


export3DXmlSettingAtt.AnnotatedView = True
Return type:

bool

property annotation_3d: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Annotation3D() As boolean

Returns or sets the 3D annotation activation flag.

Example:
This example activates the 3D annotation export.


export3DXmlSettingAtt.Annotation3D = True
Return type:

bool

property design_review: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DesignReview() As boolean

Returns or sets the Design Review activation flag.

Example:
This example activates the Design Review export.


export3DXmlSettingAtt.DesignReview = True
Return type:

bool

property geometry_representation_format: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property GeometryRepresentationFormat() As
Cat3DXmlGeomRepresentationType

Returns or sets the format of geometry representation.

Example:
This example sets the representation format to the exact
mode.


export3DXmlSettingAtt.GeometryRepresentationFormat = cat3DXmlExact
Returns:

enum cat_3d_xml_geom_representation_type

Return type:

int

get_alternate_view_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAlternateViewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations
for the alternate view setting.
Role:Retrieves the state of the alternate view setting in the current
environment.
Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_animation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnimationInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the animation
setting.
Role:Retrieves the state of the animation setting in the current
environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_annotated_view_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnnotatedViewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations
for the annotated view setting.
Role:Retrieves the state of the annotated view setting in the current
environment.
Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_annotation_3d_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnnotation3DInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the 3D annotation
setting.
Role:Retrieves the state of the 3D annotation setting in the current
environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_design_review_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDesignReviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the Design Review
setting.
Role:Retrieves the state of the Design Review setting in the current
environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_geometry_representation_format_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetGeometryRepresentationFormatInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the geometry representation format
setting.
Role:Retrieves the state of the parameter geometry representation format
setting in the current environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_measure_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetMeasureInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations
for the measure setting.
Role:Retrieves the state of the measure setting in the current
environment.
Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_ppr_save_config_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPPRSaveConfigInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the PPRSaveConfig
setting.
Role:Retrieves the state of the PPRSaveConfig setting in the current
environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_presentation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPresentationInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations
for the presentation setting.
Role:Retrieves the state of the presentation setting in the current
environment.
Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_section_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSectionInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations
for the section setting.
Role:Retrieves the state of the section setting in the current
environment.
Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_surface_accuracy_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSurfaceAccuracyInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the surface accuracy
setting.
Role:Retrieves the state of the surface accuracy setting in the current
environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_work_instructions_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetWorkInstructionsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the Work Instructions
setting.
Role:Retrieves the state of the Work Instructions setting in the current
environment.

Parameters:

AdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

property measure: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Measure() As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.get_DesignReview Returns or sets the measure activation
flag.

Example:
This example activates the measure export.


export3DXmlSettingAtt.Measure = True
Return type:

bool

property ppr_save_config: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PPRSaveConfig() As Cat3DXmlPPRSaveConfig

Returns or sets the PPR config.

Example:
This example sets the PPR config. Product And resources export is
acivated.


export3DXmlSettingAtt.PPRSaveConfig = cat3DXmlProductAndResourceList
Returns:

enum cat_3d_xml_ppr_save_config

Return type:

int

property presentation: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Presentation() As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.get_DesignReview Returns or sets the presentation
activation flag.

Example:
This example activates the presentation export.


export3DXmlSettingAtt.Presentation = True
Return type:

bool

property section: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Section() As boolean

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.get_DesignReview Returns or sets the section activation
flag.

Example:
This example activates the section export.


export3DXmlSettingAtt.Section = True
Return type:

bool

set_alternate_view_lock(i_locked: bool) → None

Note

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

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the
flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_animation_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_annotated_view_lock(i_locked: bool) → None

Note

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

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the
flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_annotation_3d_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_design_review_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_geometry_representation_format_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_measure_lock(i_locked: bool) → None

Note

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

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the
flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_ppr_save_config_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_presentation_lock(i_locked: bool) → None

Note

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

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the
flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_section_lock(i_locked: bool) → None

Note

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

Deprecated:
R19 This method will be replaced by
Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the
flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_surface_accuracy_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_work_instructions_lock(i_locked: bool) → None

Note

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

Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current
administrated. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
The locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

property surface_accuracy: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SurfaceAccuracy() As float

Returns or sets the surface accuracy.

Example:
This example sets the surface accuracy used by the exact
mode.


export3DXmlSettingAtt.SurfaceAccuracy = 0.01
Return type:

float

property work_instructions: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property WorkInstructions() As boolean

Returns or sets the Work Instructions activation flag.

Example:
This example activates the Work Instructions export.


export3DXmlSettingAtt.DesignReview = True
Return type:

bool