HiddenCalculus

Canonical path: NemAll_Python_Geometry.HiddenCalculus

Hidden calculation service implementation, user part.

This template over HiddenCalculusImpl implements type safe tag storing for hidden calculation. It holds the vector of all used tags and convert them to void* needed in HiddenCalculusImpl.

Methods:

• AddElement –

  Add element geometry to hidden world.

• Calculate –

  Runs hidden calculation.

• Configure –

  Sets parameters of calculation.

• GetLinesCount –

  Gets total count of lines calculated.

• GetResultLine –

  GetResultLine

• GetResultLineMaterial –

  Gets hidden material of element line is from.

• GetResultLineTag –

  Gets (reference to) tag hooked to element line is from.

• __init__ –

  Initialize

AddElement

AddElement(
    elementGeometry: object, elenentMaterial: HiddenMaterial, elementTag: int
)

Add element geometry to hidden world.

Parameters:

• elementGeometry (object) –

  Element geometry.

• elenentMaterial (HiddenMaterial) –

  Element material.

• elementTag (int) –

  Tag transferred over hidden calculation from element to line.

Calculate

Calculate()

Runs hidden calculation.

hrow Exception in case of internal error.

Configure

Configure(parameters: HiddenCalculationParameters)

Sets parameters of calculation.

Parameters:

• parameters (HiddenCalculationParameters) –

  New parameters.

GetLinesCount

GetLinesCount() -> int

Gets total count of lines calculated.

Returns:

• int –

  size_t Lines count.

Raises:

• Exception –

  In case of internal error and if Calculate() was not called.

GetResultLine

GetResultLine(lineIndex: int) -> tuple[Line3D, eHiddenCalculationResult]

GetResultLine

    hrow Exception if index out of range.

Parameters:

• lineIndex (int) –

  Index of line.

Returns:

• tuple[Line3D, eHiddenCalculationResult] –

  tuple(Line calculated by hidden itself, Result of hidden for line. Hidden visible)

GetResultLineMaterial

GetResultLineMaterial(lineIndex: int) -> HiddenMaterial

Gets hidden material of element line is from.

Parameters:

• lineIndex (int) –

  Index of line.

Returns:

• HiddenMaterial –

  HiddenMaterial Material.

Raises:

• Exception –

  When lineIndex is out of range.

GetResultLineTag

GetResultLineTag(lineIndex: int) -> int

Gets (reference to) tag hooked to element line is from.

Parameters:

• lineIndex (int) –

  Index of line.

Returns:

• int –

  const TagType Reference to tag object.

__init__

__init__()

Initialize

Placeholder