HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.AnalysisResult Class Reference

Contains result information for an analysis. More...

Inheritance diagram for hyperx.api.AnalysisResult:
hyperx.api.JointAnalysisResult hyperx.api.ZoneAnalysisResult hyperx.api.ZoneAnalysisConceptResult hyperx.api.ZoneAnalysisObjectResult hyperx.api.ZoneAnalysisSolverResult

Public Member Functions

 __init__ (self, _api.AnalysisResult analysisResult)

Protected Attributes

 _Entity = analysisResult

Static Protected Attributes

 _AnalysisDefinition
 _Margin

Properties

 AnalysisDefinition = property
 AnalysisDetails = property
 LimitUltimate = property
 LoadCaseId = property
 Returns the Id that can be used to access design case objects from the hyperx.api.DesignLoadCol.
 Margin = property
 ScenarioId = property
 Applicable to User FEA loads and User General loads.

Detailed Description

Contains result information for an analysis.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.AnalysisResult.__init__ ( self,
_api.AnalysisResult analysisResult )

Member Data Documentation

◆ _AnalysisDefinition

hyperx.api.AnalysisResult._AnalysisDefinition
staticprotected

◆ _Entity

hyperx.api.AnalysisResult._Entity = analysisResult
protected

◆ _Margin

hyperx.api.AnalysisResult._Margin
staticprotected

Property Documentation

◆ AnalysisDefinition

hyperx.api.AnalysisResult.AnalysisDefinition = property
static

◆ AnalysisDetails

hyperx.api.AnalysisResult.AnalysisDetails = property
static

◆ LimitUltimate

hyperx.api.AnalysisResult.LimitUltimate = property
static

◆ LoadCaseId

hyperx.api.AnalysisResult.LoadCaseId = property
static

Returns the Id that can be used to access design case objects from the hyperx.api.DesignLoadCol.

Returns
The load case Id or 0 if the load is a user load.

◆ Margin

hyperx.api.AnalysisResult.Margin = property
static

◆ ScenarioId

hyperx.api.AnalysisResult.ScenarioId = property
static

Applicable to User FEA loads and User General loads.

Returns the scenario Id.


The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py