pycatia.knowledge_interfaces.design_table

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.design_table.DesignTable(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
KnowledgeInterfaces.KnowledgeObject
KnowledgeInterfaces.KnowledgeActivateObject
KnowledgeInterfaces.Relation
DesignTable

Represents the DesignTable object.
add_association(i_parameter: Parameter, i_sheet_column: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub AddAssociation(Parameter iParameter,
CATBSTR iSheetColumn)

Adds an association between a parameter iParameter and a column of the
design table. This method does nothing if the column does not exist or if the
type of the parameter isn t compliant with the column
type.

Parameters:

iParameter
The parameter.
iSheetColumn
The name of the column to be associated with the
parameter.
Parameters:

  • i_parameter (Parameter) –

  • i_sheet_column (str) –

Return type:

None

add_new_row() → None

Note

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

Adds a row in the design table source file. The new row is filled in with values of associated
parameters. ##### Since V5R14 ##### If the file contains at least one empty row between two not
empty rows, the behavior of this method is the same for Excel and Text files : => the new row
containing the current parameters values replaces the first empty row found from the beginning of
the file. RQ : before R14, for text files, the new row was appended at the end of the file. The
empty rows were never filed by this way, so that the new row was not visible in Design Table
dialog.

Returns:
S_OK if succeeded, E_FAIL else.
Return type:

None

cell_as_string(i_row: int, i_column: int) → str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func CellAsString(short iRow,
short iColumn) As CATBSTR

Returns the content of a specific cell.

Parameters:

iRow
the index of the row where the cell is located.
iColumn
the index of the column where the cell is located.
Parameters:

  • i_row (int) –

  • i_column (int) –

Return type:

str

property columns_nb: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ColumnsNb() As short (Read Only)

Returns the nb of columns in the design table file.
Return type:

int

property configuration: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Configuration() As short

Returns or sets the current configuration. Legal values: 1 to
ConfigurationsNb.
Return type:

int

property configurations_nb: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ConfigurationsNb() As short (Read Only)

Returns the number of design table configurations.
Return type:

int

property copy_mode: bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property CopyMode() As boolean

Returns or sets whether the data contained in the file must be included
inside the CATIA model.
Return type:

bool

property file_path: str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property FilePath() As CATBSTR

Returns or sets the path of the design table (read/write property).
Return type:

str

remove_association(i_sheet_column: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub RemoveAssociation(CATBSTR iSheetColumn)

Removes an existing association. This method does nothing if the column isn
t associated or if it doesn t exist.

Parameters:

iSheetColumn
The name of an associated column.
Parameters:

i_sheet_column (str) –

Return type:

None

synchronize() → None

Note

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

Synchronizes the design table with its source file. If the file is managed
in Enovia LCA, copies this file on local disk, and synchronizes design table
content
Return type:

None