pycatia.knowledge_interfaces.report_generation_sheet_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.knowledge_interfaces.report_generation_sheet_setting_att.ReportGenerationSheetSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
ReportGenerationSheetSettingAtt

The interface to access a
CATIAReportGenerationSheetSettingAtt.
property all_checks_report: int

Note

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

Returns or sets the AllChecksReport parameter.
Role:Return or Set the AllChecksReport parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oAllChecksReport
Legal values:
0 : report of only failed checks
1 : report of all checks.
Return type:

int

property check_report_html: int

Note

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

Returns or sets the CheckReportHtml parameter.
Role:Return or Set the CheckReportHtml parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oCheckReportHtml
Legal values:
0 : to have check report in Xml
1 : to have check report in Html.
Return type:

int

property directory_for_input_xsl: str

Note

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

Returns or sets the DirectoryForInputXsl parameter.
Role:Return or Set the DirectoryForInputXsl parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oDirectoryForInputXsl
Directory for the report file with Xml extension.
Return type:

str

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetAllChecksReportInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the AllChecksReport
parameter.
Role:Retrieves the state of the AllChecksReport parameter in the current
environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetCheckReportHtmlInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the CheckReportHtml
parameter.
Role:Retrieves the state of the CheckReportHtml parameter in the current
environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetDirectoryForInputXslInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the DirectoryForInputXsl
parameter.
Role:Retrieves the state of the DirectoryForInputXsl parameter in the
current environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportCheckAdvisorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportCheckAdvisor
parameter.
Role:Retrieves the state of the ReportCheckAdvisor parameter in the current
environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportCheckExpertInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportCheckExpert
parameter.
Role:Retrieves the state of the ReportCheckExpert parameter in the current
environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportHtmlInCatiaSessionInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportHtmlInCatiaSession
parameter.
Role:Retrieves the state of the ReportHtmlInCatiaSession parameter in the
current environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportObjectsInformationInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportObjectsInformation
parameter.
Role:Retrieves the state of the ReportObjectsInformation parameter in the
current environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportOutputDirectoryInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportOutputDirectory
parameter.
Role:Retrieves the state of the ReportOutputDirectory parameter in the
current environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportParametersInformationInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportParametersInformation
parameter.
Role:Retrieves the state of the ReportParametersInformation parameter in
the current environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetReportPassedObjectsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ReportPassedObjects
parameter.
Role:Retrieves the state of the ReportPassedObjects parameter in the
current environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

property report_check_advisor: int

Note

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

Returns or sets the ReportCheckAdvisor parameter.
Role:Return or Set the ReportCheckAdvisor parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oReportCheckAdvisor
Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
Return type:

int

property report_check_expert: int

Note

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

Returns or sets the ReportCheckExpert parameter.
Role:Return or Set the ReportCheckExpert parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oReportCheckExpert
Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
Return type:

int

property report_html_in_catia_session: int

Note

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

Returns or sets the ReportHtmlInCatiaSession parameter.
Role:Return or Set the ReportHtmlInCatiaSession parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

oReportHtmlInCatiaSession
Legal values:
0 : report Html outside CATIA session
1 : report Html in CATIA session.
Return type:

int

property report_objects_information: int

Note

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

Returns or sets the ReportObjectsInformation parameter.
Role:Return or Set the ReportObjectsInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

oReportObjectsInformation
Legal values:
0 : not report objects information
1 : report objects information.
Return type:

int

property report_output_directory: str

Note

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

Returns or sets the ReportOutputDirectory parameter.
Role:Return or Set the ReportOutputDirectory parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oReportOutputDirectory
The output directory for report of checks expert and checks
advisor.
Return type:

str

property report_parameters_information: int

Note

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

Returns or sets the ReportParametersInformation parameter.
Role:Return or Set the ReportParametersInformation parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

oReportParametersInformation
Legal values:
0 : not check Advisor parameter information
1 : check Advisor parameter information.
Return type:

int

property report_passed_objects: int

Note

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

Returns or sets the ReportPassedObjects parameter.
Role:Return or Set the ReportPassedObjects parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

oReportPassedObjects
Legal values:
0 : not report passed objects
1 : report passed objects.
Return type:

int

set_all_checks_report_lock(i_locked: bool) → None

Note

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

Locks or unlocks the AllChecksReport parameter.
Role:Locks or unlocks the AllChecksReport parameter if it is possible in
the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_check_report_html_lock(i_locked: bool) → None

Note

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

Locks or unlocks the CheckReportHtml parameter.
Role:Locks or unlocks the CheckReportHtml parameter if it is possible in
the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_directory_for_input_xsl_lock(i_locked: bool) → None

Note

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

Locks or unlocks the DirectoryForInputXsl parameter.
Role:Locks or unlocks the DirectoryForInputXsl parameter if it is possible
in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_check_advisor_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportCheckAdvisor parameter.
Role:Locks or unlocks the ReportCheckAdvisor parameter if it is possible in
the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_check_expert_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportCheckExpert parameter.
Role:Locks or unlocks the ReportCheckExpert parameter if it is possible in
the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_html_in_catia_session_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportHtmlInCatiaSession parameter.
Role:Locks or unlocks the ReportHtmlInCatiaSession parameter if it is
possible in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_objects_information_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportObjectsInformation parameter.
Role:Locks or unlocks the ReportObjectsInformation parameter if it is
possible in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_output_directory_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportOutputDirectory parameter.
Role:Locks or unlocks the ReportOutputDirectory parameter if it is possible
in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_parameters_information_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportParametersInformation
parameter.
Role:Locks or unlocks the ReportParametersInformation parameter if it is
possible in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_report_passed_objects_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ReportPassedObjects parameter.
Role:Locks or unlocks the ReportPassedObjects parameter if it is possible
in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None