pycatia.dnb_reporting_interfaces.fas_reporting_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.dnb_reporting_interfaces.fas_reporting_setting_att.FasReportingSettingAtt(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

FASReportingSettingAtt

The interface to access a DNBIAFASReportingSettingAtt.

property default_style_sheet: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property DefaultStyleSheet() As CATBSTR

Gets value of “OLP Robot Program Directory” parameter.

Role: Gets value of “OLP Robot Program Directory”

parameter

Parameters:

oRobotProgramDir

Variable to return value in.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Return type:

str

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetDefaultStyleSheetInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Gets information on “OLP Robot Program Directory”

parameter.

Role: Gets information on “OLP Robot Program Directory”

parameter

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. Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetJavaClassPathInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Gets information on “Java Class Path” parameter.

Role: Gets information on “Java Class Path” parameter

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. Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetJavaExeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Gets information on “Java Executable” parameter.

Role: Gets information on “Java Executable” parameter

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. Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetResultOutputDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Gets information on “OLP Robot Program Directory”

parameter.

Role: Gets information on “OLP Robot Program Directory”

parameter

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. Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetStyleSheetDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Gets information on “OLP Robot Program Directory”

parameter.

Role: Gets information on “OLP Robot Program Directory”

parameter

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. Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetSVGViewerInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Gets information on “OLP Robot Program Directory”

parameter.

Role: Gets information on “OLP Robot Program Directory”

parameter

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. Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property java_class_path: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property JavaClassPath() As CATBSTR

Gets value of “Java Class Path” parameter.

Role: Gets value of “Java Class Path” parameter

Parameters:

o

JavaClassPath Variable to return value in.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Return type:

str

property java_exe: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property JavaExe() As CATBSTR

Gets value of “Java Executable” parameter.

Role: Gets value of “Java Executable” parameter

Parameters:

oJavaExe

Variable to return value in.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Return type:

str

property result_output_dir: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property ResultOutputDir() As CATBSTR

Gets value of “OLP Robot Program Directory” parameter.

Role: Gets value of “OLP Robot Program Directory”

parameter

Parameters:

oRobotProgramDir

Variable to return value in.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Return type:

str

set_default_style_sheet_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetDefaultStyleSheetLock(boolean iLocked)

Locks or unlocks the “OLP Robot Program Directory”

parameter.

Role: Locks or unlocks the “OLP Robot Program Directory” parameter if the

operation is allowed in the current administrated environment. 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_java_class_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetJavaClassPathLock(boolean iLocked)

Locks or unlocks the “Java Class Path” parameter.

Role: Locks or unlocks the “Java Class Path” parameter if the operation is

allowed in the current administrated environment. 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_java_exe_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetJavaExeLock(boolean iLocked)

Locks or unlocks the “Java Executable” parameter.

Role: Locks or unlocks the “Java Executable” parameter if the operation is

allowed in the current administrated environment. 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_result_output_dir_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetResultOutputDirLock(boolean iLocked)

Locks or unlocks the “OLP Robot Program Directory”

parameter.

Role: Locks or unlocks the “OLP Robot Program Directory” parameter if the

operation is allowed in the current administrated environment. 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_style_sheet_dir_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetStyleSheetDirLock(boolean iLocked)

Locks or unlocks the “OLP Robot Program Directory”

parameter.

Role: Locks or unlocks the “OLP Robot Program Directory” parameter if the

operation is allowed in the current administrated environment. 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_svg_viewer_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetSVGViewerLock(boolean iLocked)

Locks or unlocks the “OLP Robot Program Directory”

parameter.

Role: Locks or unlocks the “OLP Robot Program Directory” parameter if the

operation is allowed in the current administrated environment. 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 style_sheet_dir: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property StyleSheetDir() As CATBSTR

Gets value of “OLP Robot Program Directory” parameter.

Role: Gets value of “OLP Robot Program Directory”

parameter

Parameters:

oRobotProgramDir

Variable to return value in.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Return type:

str

property svg_viewer: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property SVGViewer() As long

Gets value of “OLP Robot Program Directory” parameter.

Role: Gets value of “OLP Robot Program Directory”

parameter

Parameters:

oRobotProgramDir

Variable to return value in.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Return type:

int