CAE ProbeTable

xAddProbeTable

Creates a user text based ProbeTable for a given Node ID.

size_t xAddProbeTable(String sModel, String sPart, int iNodeID, List<String> sTextArray)

return

Returns new ProbeTable’s ID.

sModel

Model name for the ProbeTable to be associated.

sPart

Part name where the Node ID belongs to.

iNodeID

Node ID for the ProbeTable to be created.

sText`Array

New user text array. Each array entry will be added as a user text label field.

xCAEProbeTableAddRow

Adds rows to ProbeTable.

bool xCAEProbeTableAddRow(size_t iTableID, int iNoOfRows, int iFieldsMode)

return

Returns True, if successful.

iTableID

ProbeTable ID.

iNoOfRows

Number of rows to be added.

iFieldsMode

Specifies how the new row will be added.

0 - Same as last row fields
1 - All Text field

xCAEProbeTableAddColumn

Adds column to ProbeTable.

bool xCAEProbeTableAddColumn(size_t iTableID, int iCol, int iFieldsMode)

return

Returns True, if successful.

iTableID

ProbeTable ID.

iCol

Number of columns to be added.

iFieldsMode

Specifies how the new column will be added.

0 - Same as last column fields
1 - All Text field

xCAEProbeTableDeleteRow

Deletes a specified row in the ProbeTable.

bool xCAEProbeTableDeleteRow(size_t iTableID, int iRow)

return

Returns True, if successful.

iTableID

ProbeTable ID.

iRow

Index of the row to be deleted.

xCAEProbeTableDeleteColumn

Deletes a specified column in the ProbeTable.

bool xCAEProbeTableDeleteColumn(size_t iTableID, int iCol)

return

Returns True, if successful.

iTableID

ProbeTable ID.

iCol

Index of the column to be deleted.

xCAEProbeTableSetText

Sets text in a ProbeTable’s label field.

bool xCAEProbeTableSetText(size_t iTableID, int iRow, int iCol, String sText)

return

Returns True, if successful.

iTableID

ProbeTable ID.

iRow iCol

Row and column index.

sText

New text.

xCAEProbeTableGetText

Gets text in a ProbeTable label field.

String xCAEProbeTableGetText(size_t iTableID, int iRow, int iCol)

return

Returns text that is set in the required table label.

iTableID

ProbeTable ID.

iRow iCol

Row and column index.

//2D Table

xSetProbeTableTemplate

Sets ProbeTable’s display as transpose matrix. (Table Template 1 or Template 2)

bool xSetProbeTableTemplate(size_t iTableID, int iTemplate)

return

Returns True, if successful.

iTableID

ProbeTable ID.

iTemplate

0 - Normal template( Template 1)
1 - Transposed template (Template 2)

xGetProbeTableTemplate

Gets ProbeTable’s template mode.

int xGetProbeTableTemplate(size_t iTableID)

return

Returns currently set template for the ProbeTable.

 0 - Normal template( Template 1)
 1 - Transposed template (Template 2)
-1 - Error in input

iTableID

ProbeTable ID.

pxGetProbeTableModels

Gets ProbeTable’s associated models.

List<String> pxGetProbeTableModels(size_t iTableID)

return

Returns this ProbeTable’s associated models in an array. Model name in Index 0 stands for the model ProbeTable belongs to.

iTableID

ProbeTable ID.

pxGetProbeTableParts

Gets ProbeTable’s associated parts.

List<String> pxGetProbeTableParts(size_t iTableID)

return

Returns this ProbeTable associated parts in an array. Model name in Index 0 stands for ProbeTable’s part from its model.

iTableID

ProbeTable ID.

xShowProbeTableMatrix

Sets display of ProbeTable’s matrix field.

bool xShowProbeTableMatrix(size_t iTableID, bool bShow)

return

Returns True, if successful.

iTableID

ProbeTable ID.

bShow

Set True to show all matrix files incluing row and column headers. Set False to hide all matrix fileds.

xIsProbeTableMatrixVisible

Gets display info of ProbeTable’s matrix field.

bool xIsProbeTableMatrixVisible(size_t iTableID)

return

Returns True, if matrix field is visible.

iTableID

ProbeTable ID.

xGetProbeTableRowCount

Gets number of rows of the ProbeTable.

int xGetProbeTableRowCount(size_t iTableID)

return

Returns number of rows in the table. When error occurs returns -1.

iTableID

ProbeTable ID.

xGetProbeTableColumnCount

Gets number of columns of the ProbeTable.

int xGetProbeTableColumnCount(size_t iTableID)

return

Returns number of columns in the table. When error occurs returns -1.

iTableID

ProbeTable ID.

xIsProbeTableVisible

Checks probe table is shown or hidden.

bool xIsProbeTableVisible(size_t iTableID)

return

Retruns True, if the table is not hidden.

iTableID

CAE Probe Table ID.

pxGetAllVisibleProbeTableIDs

Gets visible probeTable IDs of a model.

List<size_t> pxGetAllVisibleProbeTableIDs(String sModel)

return

Returns visible ProbeTable’s IDs.

sModel

Model name. If it is empty String “”, will return all models IDs.

xFitViewToTables

Set camera focus to given ProbeTable IDs attached position.

bool xFitViewToTables(String sModel, List<size_t> TableIDs)

return

Returns True if successful.

sModel

Model Name. For future use.

TableIDs

Array of PeobeTable IDs for what focus has to be set.

xShowProbeTableRow

Show/Hides ProbeTable’s row.

bool xShowProbeTableRow(size_t iTableID, int iRow, bool bShow)

return

Returns True, If successful.

iTableID

ProbeTable ID.

iRow

Row index to show/hide in the ProbeTable matrix.

bShow

Set True to show.

xIsProbeTableRowVisible

Gets visible state of a row in ProbeTable.

bool xIsProbeTableRowVisible(size_t iTableID, int iRow)

return

Returns True, if visible.

iTableID

ProbeTable ID.

iRow

Row index to show/hide in the ProbeTable matrix.

xShowProbeTableCol

Shows/Hides ProbeTable’s column.

bool xShowProbeTableCol(size_t iTableID, int iCol, bool bShow)

return

Returns True, If successful.

iTableID

ProbeTable ID.

iCol

Column index to show/hide in the ProbeTable matrix.

bShow

Set True to show.

xIsProbeTableColVisible

Gets visible state of a column in ProbeTable.

bool xIsProbeTableColVisible(size_t iTableID, int iCol)

return

Returns True, if visible.

iTableID

ProbeTable ID.

iCol

Column index in the ProbeTable matrix.

pxGetProbeTableIDs

Gets Probe Table IDs for a set of parts in a model.

List<size_t> pxGetProbeTableIDs(String sModel, List<String> sPartsList)

return

Returns Table ID in an array.

sModel

Model name.

sPartsList

Parts list for which Probe Table IDs are required.

pxGetProbeNodeIDs

Gets NodeID of probed tables for a set of parts in a model.

List<size_t> pxGetProbeNodeIDs(String sModel, List<String> sPartsList)

return

Returns NodeID in an array.

sModel

Model name.

sPartsList

Parts list for which NodeIDs of probed tables are required.

pxGetProbeTableNodeIDs

Gets Node IDs associated with the probe table ID.

List<size_t> pxGetProbeTableNodeIDs(size_t iProbeTableID)

return

Returns an array of node ids associated with the probe table, empty array if failed.

iProbeTableID

Probe table ID.

pxGetProbeTableElementIDs

Gets Element IDs associated with the probe table ID.

List<size_t> pxGetProbeTableElementIDs(size_t iProbeTableID)

return

Returns an array of element ids associated with theprobe table, empty array if failed.

iProbeTableID

Probe table ID.

xSetArrangeLabelMode

Arranges the CAE probe labels based on the given type.

void xSetArrangeLabelMode(int iMode)

return

None

iMode

0 – Near/Actual
1 - Top-Bottom
2 - Compact
3 - Circular
4 - Silhouette
5 - Rectangular

xGetArrangeLabelMode

Gets last applied Arrange labels mode.

int xGetArrangeLabelMode()

return

Returns an integer between 0 and 5

0 -Near/ Actual
1 - Top-Bottom
2 - Compact
3 - Circular
4 - Silhouette
5 - Rectangular