Parameters

createParam(Name, ParamType, ValueFormula, Unit)

Create a parameter

Parameters:
  • Name (str) – Name: Parameter name.

  • Enumerate – { DOUBLE, INTEGER, STRING, BOOLEAN, POINT2D, POINT3D, VECTOR2D, VECTOR3D } ParamType: Parameter type: String as: { DOUBLE, INTEGER, STRING, BOOLEAN, POINT2D, POINT3D, VECTOR2D, VECTOR3D }.

  • ValueFormula (str) – Value: Value or formula.

  • Unit (str) – Unit: Unit to use by this param.

createParam(Name, ParamType, CoordSys, ValueFormula, Unit)

Create a parameter

Parameters:
  • Name (str) – Name: Parameter name.

  • Enumerate – { DOUBLE, INTEGER, STRING, BOOLEAN, POINT2D, POINT3D, VECTOR2D, VECTOR3D } ParamType: Parameter type: String as: { DOUBLE, INTEGER, STRING, BOOLEAN, POINT2D, POINT3D, VECTOR2D, VECTOR3D }.

  • CoordSys (str) – Coord system: Used as reference system.

  • ValueFormula (str) – Value: Value or formula.

  • Unit (str) – Unit: Unit to use by this param.

deleteParam(Name)

Erase a parameter given its name.

Parameters:

Name (str) – Parameter name: Name whose parameter to erase.

modifyParam(Name, ValueFormula, Unit)

Modify a parameter

Parameters:
  • Name (str) – Name: Parameter name.

  • ValueFormula (str) – Value: Value or formula.

  • Unit (str) – Unit: Unit to use by this param.

modifyParam(Name, CoordSys, ValueFormula, Unit)

Modify a parameter

Parameters:
  • Name (str) – Name: Parameter name.

  • CoordSys (str) – Coord system: Used as reference system.

  • ValueFormula (str) – Value: Value or formula.

  • Unit (str) – Unit: Unit to use by this param.

renameParam(OldName, NewName)

Changes the name of a parameter

Parameters:
  • OldName (str) – Old name.

  • NewName (str) – New name.