Basic types

Point:

Represents a point with x, y and z coordinates in 3D space

__init__(x, y, z, unit)

Initializes a Point3d structure

Parameters:
  • x (float) – X coordinate

  • y (float) – Y coordinate

  • z (float) – Z coordinate

  • unit (str) – Unit to use

x()

X coordinate

Returns:

Return type:

float

y()

Y coordinate

Returns:

Return type:

float

z()

Z coordinate

Returns:

Return type:

float

getUnit()

Obtains the unit as a string

Returns:

Return type:

string

getFormula()

Obtains the formula used by the object if set

Returns:

Return type:

Formula

Vector:

Represents a vector with x, y and z values in 3D space

__init__(x, y, z, unit)

Initializes a Vector3d structure

Parameters:
  • x (float) – X coordinate

  • y (float) – Y coordinate

  • z (float) – Z coordinate

  • unit (str) – Unit to use

x()

X coordinate

Returns:

Return type:

float

y()

Y coordinate

Returns:

Return type:

float

z()

Z coordinate

Returns:

Return type:

float

getUnit()

Obtains the unit as a string

Returns:

Return type:

string

getFormula()

Obtains the formula used by the object if set

Returns:

Return type:

Formula

Double:

Represents a double value with a unit

__init__(value, unit)

Initializes a Double structure

Parameters:
  • value (float) – Initial value

  • unit (str) – Unit to use

value()

Initial value

Returns:

Return type:

float

unit()

Unit to use

Returns:

Return type:

str

getValue()

Obtains the value as float

Returns:

Return type:

float

getValueUnit(unit)

Obtains the value as float, for the unit given

Parameters:

unit (string)

Returns:

Return type:

float

getUnit()

Obtains the unit as a string

Returns:

Return type:

string

getFormula()

Obtains the formula used by the object if set

Returns:

Return type:

Formula

List:

Container for a list of model elements. Can be accessed with [ ]

front()

Obtains the first element

Returns:

First element, if not empty

Return type:

Element type

back()

Obtains the last element

Returns:

Last element, if not empty

Return type:

Element type

size()

Obtains the list size

Returns:

Return type:

int

empty()

Checks if the list is empty

Returns:

Return type:

bool

push(newElement)

Insert an element at the end of the list

Parameters:

newElement (float) – New value

Table:

Container for a matrix of model elements

get(i, j)

Obtains an element value

Parameters:
  • i (int) – Row

  • j (int) – Column

Returns:

Return type:

Element type

set(i, j, newValue)

Changes the value of an element

Parameters:
  • i (int) – Row

  • j (int) – Column

  • newValue (Element type)

getNumRows()

Get the number of rows

Returns:

Return type:

int

getNumCols()

Get the number of columns

Returns:

Return type:

int

setTableUnit(unit)

Sets the unit for the table data

Parameters:

unit (str) – Unit to use

setFirstRowUnit(unit)

Sets the unit for the row header

Parameters:

unit (str) – Unit to use

setFirstColUnit(unit)

Sets the unit for the column header

Parameters:

unit (str) – Unit to use

insertRow(cellValue)

Inserts a row in an orderer position using the value given for the cell

Parameters:

cellValue (Element type) – New value

insertCol(cellValue)

Inserts a column in an orderer position using the value given for the cell

Parameters:

cellValue (Element type) – New value

removeRow(rowNumber)

Removes a row

Parameters:

rowNumber (int) – Row

removeColumn(colNumber)

Remove a column

Parameters:

colNumber (int) – Column

Formula:

Represents a CivilFEM formula string

__init__(strFormula)

Initializes a Formula structure

Parameters:

strFormula (str) – String with formula

evaluate()

Evaluate the formula and get the result as a string

Returns:

Return type:

string with the result of the formula