Global Results
Model-wide results after analysis — mode frequencies, mass participation, buckling factors, and time-history response. Read-only.
11 functions
Get
GetBucklingFactor
Description
Returns the buckling factor.
Parameters
buckling_mode_no(int): buckling mode no.
Returns
float: A numeric value returned by STAAD.Pro for this call.
Example
from openstaad import ops
s = ops.connect()
result = s.GetBucklingFactor(1)
print(result)
GetModalMassParticipationFactors
Description
Returns the modal mass participation factors.
Parameters
modeNo(int): mode no.
Returns
tuple: A tuple of (float, float, float).
Example
from openstaad import ops
s = ops.connect()
result = s.GetModalMassParticipationFactors(1)
print(result)
GetModeFrequency
Description
Returns the mode frequency.
Parameters
modeNo(int): mode no.
Returns
float: A numeric value returned by STAAD.Pro for this call.
Example
from openstaad import ops
s = ops.connect()
result = s.GetModeFrequency(1)
print(result)
GetNoOfBucklingFactors
Description
Returns the number of the buckling factors.
Parameters
None.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetNoOfBucklingFactors()
print(result)
GetNoOfModesExtracted
Description
Returns the number of the modes extracted.
Parameters
None.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetNoOfModesExtracted()
print(result)
GetTimeHistoryIntegrationStepInfo
Description
Returns the time history integration step info.
Parameters
None.
Returns
tuple: A tuple of (float, raw).
Example
from openstaad import ops
s = ops.connect()
result = s.GetTimeHistoryIntegrationStepInfo()
print(result)
GetTimeHistoryResponse
Description
Returns the time history response.
Parameters
load_case(int): load case.node_no(int): node no.dof_no(int): dof no.response_type(int): response type.
Returns
list: A list of numbers (floats).
Example
from openstaad import ops
s = ops.connect()
result = s.GetTimeHistoryResponse(1, 1, 1, 1)
print(result)
GetTimeHistoryResponseAtTime
Description
Returns the time history response at time.
Parameters
load_case(int): load case.node_no(int): node no.dof_no(int): dof no.response_type(int): response type.at_time(float): at time.
Returns
tuple: A tuple of (float, raw).
Example
from openstaad import ops
s = ops.connect()
result = s.GetTimeHistoryResponseAtTime(1, 1, 1, 1, 1.0)
print(result)
GetTimeHistoryResponseMinMax
Description
Returns the time history response min max.
Parameters
load_case(int): load case.node_no(int): node no.dof_no(int): dof no.response_type(int): response type.
Returns
tuple: A tuple of (float, float, float, float).
Example
from openstaad import ops
s = ops.connect()
result = s.GetTimeHistoryResponseMinMax(1, 1, 1, 1)
print(result)
Is
AreResultsAvailable
Description
Checks whether results available.
Parameters
None.
Returns
bool: True if the call succeeded, False otherwise.
Example
from openstaad import ops
s = ops.connect()
result = s.AreResultsAvailable()
print(result)
IsBucklingAnalysisResultsAvailable
Description
Checks whether buckling analysis results available.
Parameters
None.
Returns
bool: True if the call succeeded, False otherwise.
Example
from openstaad import ops
s = ops.connect()
result = s.IsBucklingAnalysisResultsAvailable()
print(result)