Skip to main content
Version: 14

viktor.external.etabs

ETABSAnalysis​

class viktor.external.etabs.etabs.ETABSAnalysis(script=None, script_key='', files=None, output_filenames=None)

Bases: PythonAnalysis

New in 14.17.0

ETABSAnalysis can be used to evaluate an ETABS-python script on third-party infrastructure. The script is expected to be blocking, i.e. if the script is invoked from command prompt, it should wait until the executable is finished. The default behaviour, is that the python script is defined within the app and send to the worker to be executed on third-party infrastructure. If desired (due to security considerations) the worker can be configured to only run local scripts. These scripts must be defined the in worker configuration file and can be selected through the script_key.

Usage:

script = vkt.File.from_path(Path(__file__).parent / "run_etabs.py")
files = [
    ('input1.txt', file1),
]
analysis = ETABSAnalysis(script=script, files=files, output_filenames=["output.txt"])
analysis.execute(timeout=60)
output_file = analysis.get_output_file("output.txt")

Exceptions which can be raised during calculation:

Parameters:

  • script (File) – Script file that is transferred to the working directory on the server.

  • script_key (str) – The key of the script that needs to be run. Only use this when the worker is configured to run local scripts. This key should be present in the configuration file of the worker.

  • files (List[Tuple[str, BytesIO | File]]) – Additional files that are transferred to the working directory on the server. Each file is a tuple containing the content and the filename which is used to save on the infrastructure.

  • output_filenames (List[str]) – A list of filenames (including extension) that are to be transferred back to the app. This filename is relative to the working directory.

Either one of ‘script’ or ‘script_key’ should be defined.

Raises:

ValueError – when neither ‘script’ or ‘script_key’ is included OR when both are included.

ETABSConnection​

class viktor.external.etabs.etabs.ETABSConnection(session)

Bases: _CSIConnection

New in 14.31.0

The sap object returned by connect(), used to control ETABS through the ETABS OAPI. Use the default OAPI calls with comtypes syntax. Each call returns the OAPI result: the status code, or [*out_params, status] when the call has output parameters.

Warning

Do not instantiate this class directly; obtain it from connect().

connect​

viktor.external.etabs.etabs.connect(timeout=60)

New in 14.31.0

Connect to ETABS running on a connected VIKTOR worker and control it through the ETABS OAPI directly from your app, as shown below.

Warning

This is a BETA feature.

Requires a worker of kind etabsconnect. Declare it in your viktor.config.toml:

worker_integrations = [
    "etabsconnect",
]

Usage:

import viktor as vkt

with vkt.etabs.connect(timeout=60) as sap:
    ret = sap.InitializeNewModel(vkt.etabs.eUnits.kN_m_C)  # a call returns the status code
    [beam_name, ret] = sap.FrameObj.AddByCoord(0, 0, 0, 6, 0, 0, "", "Default", "Beam", "Global")
    [pt_i, pt_j, ret] = sap.FrameObj.GetPoints(beam_name, "", "")  # ...or out-params, then status
    sap.File.Save("model.edb")  # use a relative filename, not an absolute path

Note

The OAPI members you call on sap (e.g. sap.FrameObj.AddByCoord) mirror the ETABS OAPI and are surfaced through IDE autocomplete rather than listed here. Look them up in the ETABS OAPI reference: the CSI API ETABS v1.chm help file in your ETABS installation directory (e.g. C:/Program Files/Computers and Structures/ETABS <version>/), or on CSI’s developer site.

Parameters:

timeout (int) – per-call timeout in seconds.

Return type:

ETABSConnection

Exceptions which can be raised during execution:

  • viktor.errors.ExecutionError: generic error. Error message provides more information. A host whose ETABS license is not activated also fails this way: ETABS blocks on an interactive sign-in dialog that the worker cannot answer, so starting it up times out.

  • viktor.errors.WorkerSessionError: the session was lost (e.g. its ETABS instance was torn down). The session cannot be resumed; start a new one to continue.

  • TimeoutError: a call took longer than timeout

OAPI enum values, generated from ETABS 23.3.1 (Ultimate).

e2DFrameType​

class viktor.external.etabs.enums.e2DFrameType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI e2DFrameType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ConcentricBraced = 1
EccentricBraced = 2
PortalFrame = 0

e3DFrameType​

class viktor.external.etabs.enums.e3DFrameType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI e3DFrameType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

BeamSlab = 2
FlatPlate = 3
OpenFrame = 0
PerimeterFrame = 1

eAreaDesignOrientation​

class viktor.external.etabs.enums.eAreaDesignOrientation(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eAreaDesignOrientation values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Floor = 2
Null = 4
Other = 5
Ramp_DO_NOT_USE = 3
Wall = 1

eBridgeCodeAASHTO​

class viktor.external.etabs.enums.eBridgeCodeAASHTO(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeCodeAASHTO values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

AASHTO_LRFD_2007 = 1
AASHTO_LRFD_2012 = 2
AASHTO_LRFD_2014 = 3
AASHTO_LRFD_2017 = 4
AASHTO_LRFD_2020 = 5
AASHTO_STD_2002 = 0

eBridgeCodeInterims​

class viktor.external.etabs.enums.eBridgeCodeInterims(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeCodeInterims values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Interim_2011 = 1
Interim_2012 = 2
Interim_2013 = 3
Interim_2014 = 4
Interim_2015 = 5
NoInterims = 0

eBridgeObjectBentPart​

class viktor.external.etabs.enums.eBridgeObjectBentPart(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeObjectBentPart values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Bearing = 3
CapBeam = 1
Column = 2
Wall = 4

eBridgeObjectFoundationPart​

class viktor.external.etabs.enums.eBridgeObjectFoundationPart(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeObjectFoundationPart values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Footing = 1
FoundationSpring = 4
Pile = 3
PileCap = 2

eBridgeObjectType​

class viktor.external.etabs.enums.eBridgeObjectType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeObjectType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

General = 0
Segmental = 1

eBridgeObjectUserPointType​

class viktor.external.etabs.enums.eBridgeObjectUserPointType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeObjectUserPointType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

General = 0
SegmentalTendon = 1

eBridgeResponseDesignRating​

class viktor.external.etabs.enums.eBridgeResponseDesignRating(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeResponseDesignRating values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Design_Crack_Bot_Crack_Width = 55
Design_Crack_Top_Bot_Crack_Widths = 56
Design_Crack_Top_Crack_Width = 54
Design_Fatigue_Bot_Flange_Lateral_Bending_Stress_Range = 75
Design_Fatigue_Bot_Flange_Tensile_Stress_Range_Without_FLB = 74
Design_Fatigue_DC_Ratio_Web_Shear = 76
Design_Fatigue_Top_Flange_Tensile_Stress_Range_Without_FLB = 73
Design_Flexure_Moment_About_Horizontal_Axis_M3 = 64
Design_Principal_Stress_Beam_Web_Bot = 61
Design_Principal_Stress_Beam_Web_Top = 60
Design_Principal_Stress_Envelope = 57
Design_Principal_Stress_Neutral_Axis = 62
Design_Principal_Stress_Web_Bot = 59
Design_Principal_Stress_Web_Top = 58
Design_Shear_Controlling_DC_Ratio = 43
Design_Shear_Controlling_Shear_DC_Ratio = 34
Design_Shear_Controlling_Torsion_DC_Ratio = 35
Design_Shear_Demand_Concrete_Shear_Capacity_Ratio = 33
Design_Shear_Longit_Rebar_Area = 45
Design_Shear_Longit_Rebar_Area_Beam = 50
Design_Shear_Longit_Rebar_Area_Bot_Flange = 48
Design_Shear_Longit_Rebar_Area_Bot_Slab = 46
Design_Shear_Longit_Rebar_Area_Slab = 49
Design_Shear_Longit_Rebar_Area_Top_Slab = 47
Design_Shear_Longit_Torsional_Rebar_Area_PerL = 51
Design_Shear_Rebar_Area_PerL = 44
Design_Shear_Required_Extra_Longit_Rebar_Area = 37
Design_Shear_Required_Extra_Longit_Rebar_Area_Beam = 42
Design_Shear_Required_Extra_Longit_Rebar_Area_Bot_Slab = 39
Design_Shear_Required_Extra_Longit_Rebar_Area_For_Torsion = 38
Design_Shear_Required_Extra_Longit_Rebar_Area_Slab = 41
Design_Shear_Required_Extra_Longit_Rebar_Area_Top_Slab = 40
Design_Shear_Required_Extra_Shear_Rebar_Area_PerL = 36
Design_Shear_Torsion_Plus_Shear_Rebar_Area_PerL = 53
Design_Shear_Torsion_Rebar_Area_PerL = 52
Design_Strength_DC_Ratio_FlexureShearInteract_Neg = 71
Design_Strength_DC_Ratio_FlexureShearInteract_Pos = 70
Design_Strength_DC_Ratio_Negative_Moment = 66
Design_Strength_DC_Ratio_Net_Section_Fracture_Neg = 69
Design_Strength_DC_Ratio_Net_Section_Fracture_Pos = 68
Design_Strength_DC_Ratio_Positive_Moment = 65
Design_Strength_DC_Ratio_Shear = 67
Design_Strength_Total_Nominal_Shear_Force_6_10_10_4_2 = 72
Design_Tendon_Stress_Controlling_DC_Ratio = 63
Rating_ASM_Rating = 94
Rating_Flexure = 81
Rating_Flexure_Factored_Moment_Resistance = 82
Rating_Flexure_Factored_Moment_Resistance_UMr = 83
Rating_Flexure_Live_load_Capacity_Factor_F = 84
Rating_LFM_Service_Rating = 96
Rating_LFM_Strength_Rating = 95
Rating_MinRebar_Flexure_Rating = 92
Rating_MinRebar_Min_Of_Abs_1_2Mcr_And_Abs_1_33Mu_For_Neg = 91
Rating_MinRebar_Min_Of_Abs_1_2Mcr_And_Abs_1_33Mu_For_Pos = 90
Rating_Service = 93
Rating_Service_Flexure_Rating = 89
Rating_Shear = 77
Rating_Shear_Factored_Shear_Resistance = 78
Rating_Shear_Factored_Shear_Resistance_UVr = 79
Rating_Shear_Live_load_Capacity_Factor_F = 80
Rating_Strength_Flexure_Rating = 86
Rating_Strength_Live_load_Capacity_Factor_F_Moment_M3 = 87
Rating_Strength_Live_load_Capacity_Factor_F_Shear_V2 = 88
Rating_Strength_Shear_Rating = 85
S11_Longitudinal_Beam_Bot_Center = 39
S11_Longitudinal_Beam_Bot_Envelope = 32
S11_Longitudinal_Beam_Bot_Left = 29
S11_Longitudinal_Beam_Bot_Right = 31
S11_Longitudinal_Beam_Top_Center = 10
S11_Longitudinal_Beam_Top_Envelope = 12
S11_Longitudinal_Beam_Top_Left = 9
S11_Longitudinal_Beam_Top_Right = 11
S11_Longitudinal_Bot_Center = 15
S11_Longitudinal_Bot_Envelope = 18
S11_Longitudinal_Bot_Left = 13
S11_Longitudinal_Bot_Left_Corner = 14
S11_Longitudinal_Bot_Right = 16
S11_Longitudinal_Bot_Right_Corner = 17
S11_Longitudinal_Girder_Bot_Envelope = 21
S11_Longitudinal_Girder_Bot_Left = 19
S11_Longitudinal_Girder_Bot_Right = 20
S11_Longitudinal_Slab_Bot_Beam_Center = 24
S11_Longitudinal_Slab_Bot_Beam_Left = 23
S11_Longitudinal_Slab_Bot_Beam_Right = 25
S11_Longitudinal_Slab_Bot_Center = 26
S11_Longitudinal_Slab_Bot_Envelope = 28
S11_Longitudinal_Slab_Bot_Left = 22
S11_Longitudinal_Slab_Bot_Right = 27
S11_Longitudinal_Slab_Top_Beam_Center = 6
S11_Longitudinal_Slab_Top_Center = 5
S11_Longitudinal_Slab_Top_Envelope = 8
S11_Longitudinal_Slab_Top_Left = 4
S11_Longitudinal_Slab_Top_Right = 7
S11_Longitudinal_Top_Center = 1
S11_Longitudinal_Top_Envelope = 3
S11_Longitudinal_Top_Left = 0
S11_Longitudinal_Top_Right = 2

eBridgeResponseDisplDOF​

class viktor.external.etabs.enums.eBridgeResponseDisplDOF(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeResponseDisplDOF values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Avg_Longitudinal_Rotation = 4
Longitudinal_Displacement = 2
Longitudinal_Rotation = 3
Transverse_Displacement = 1
Vertical_Displacement = 0

eBridgeResponseDisplLoc​

class viktor.external.etabs.enums.eBridgeResponseDisplLoc(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeResponseDisplLoc values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Left_Web = 5
Left_Web_Bottom = 4
Left_Web_Top = 3
Right_Web = 8
Right_Web_Bottom = 7
Right_Web_Top = 6
Slab_Center = 9
Web = 2
Web_Bottom = 1
Web_Top = 0

eBridgeResponseForce​

class viktor.external.etabs.enums.eBridgeResponseForce(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeResponseForce values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Axial_Force_P = 1
Moment_About_Horizontal_Axis_M3 = 6
Moment_About_Vertical_Axis_M2 = 5
Shear_Horizontal_V3 = 3
Shear_Vertical_V2 = 2
Torsion_T = 4

eBridgeResponsePart​

class viktor.external.etabs.enums.eBridgeResponsePart(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeResponsePart values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

All_Beams = 7
All_Girders = 6
All_Slabs = 9
All_Webs = 8
Beam = 3
Entire_Bridge_Section = 1
Entire_Section_Plus_All_Girders = 10
Girder = 2
Slab = 5
Web = 4

eBridgeResponseStress​

class viktor.external.etabs.enums.eBridgeResponseStress(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeResponseStress values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

S11_Lateral_Bending_Bot = 25
S11_Lateral_Bending_Top = 22
S11_Lateral_Bending_Top_ULeft = 23
S11_Lateral_Bending_Top_URight = 24
S11_Longitudinal_Bot_Beam_Left = 16
S11_Longitudinal_Bot_Beam_Right = 17
S11_Longitudinal_Bot_Center = 14
S11_Longitudinal_Bot_Envelope = 18
S11_Longitudinal_Bot_Left = 13
S11_Longitudinal_Bot_Right = 15
S11_Longitudinal_Top_Beam_Center = 3
S11_Longitudinal_Top_Bot_Center = 20
S11_Longitudinal_Top_Bot_Left = 19
S11_Longitudinal_Top_Bot_Right = 21
S11_Longitudinal_Top_Center = 1
S11_Longitudinal_Top_Envelope = 4
S11_Longitudinal_Top_Left = 0
S11_Longitudinal_Top_Right = 2
S11_Longitudinal_Top_ULeft_Center = 6
S11_Longitudinal_Top_ULeft_Envelope = 8
S11_Longitudinal_Top_ULeft_Left = 5
S11_Longitudinal_Top_ULeft_Right = 7
S11_Longitudinal_Top_URight_Center = 10
S11_Longitudinal_Top_URight_Envelope = 12
S11_Longitudinal_Top_URight_Left = 9
S11_Longitudinal_Top_URight_Right = 11

eBridgeSegmentConstructionMethod​

class viktor.external.etabs.enums.eBridgeSegmentConstructionMethod(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeSegmentConstructionMethod values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

CastInPlace = 1
Precast = 0

eBridgeSegmentType​

class viktor.external.etabs.enums.eBridgeSegmentType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeSegmentType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Closure = 3
PierTable = 1
Rigid = 0
Segment = 2

eBridgeTendonCategory​

class viktor.external.etabs.enums.eBridgeTendonCategory(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eBridgeTendonCategory values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

BottomSpan = 2
Cantilever = 1
Continuity = 4
General = 0
TopSpan = 3

eCNameType​

class viktor.external.etabs.enums.eCNameType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eCNameType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

LoadCase = 0
LoadCombo = 1

eConstraintAxis​

class viktor.external.etabs.enums.eConstraintAxis(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eConstraintAxis values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

AutoAxis = 4
X = 1
Y = 2
Z = 3

eConstraintType​

class viktor.external.etabs.enums.eConstraintType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eConstraintType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Beam = 5
Body = 1
Diaphragm = 2
Equal = 6
Line = 13
Local = 7
Plate = 3
Rod = 4
Weld = 8

eDeckType​

class viktor.external.etabs.enums.eDeckType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eDeckType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Filled = 1
SolidSlab = 3
Unfilled = 2

eDesignActionType​

class viktor.external.etabs.enums.eDesignActionType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eDesignActionType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

LongTermComposite = 3
NonComposite = 1
Other = 5
ShortTermComposite = 2
Staged = 4

eDiaphragmOption​

class viktor.external.etabs.enums.eDiaphragmOption(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eDiaphragmOption values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

DefinedDiaphragm = 3
Disconnect = 1
FromShellObject = 2

eFileTypeIO​

class viktor.external.etabs.enums.eFileTypeIO(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eFileTypeIO values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

DBTablesAccess = 3
DBTablesExcel = 2
DBTablesText = 4
DBTablesXML = 5
TextFile = 1

eForce​

class viktor.external.etabs.enums.eForce(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eForce values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

N = 3
NotApplicable = 0
kN = 4
kgf = 5
kip = 2
lb = 1
tonf = 6

eFrameDesignOrientation​

class viktor.external.etabs.enums.eFrameDesignOrientation(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eFrameDesignOrientation values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Beam = 2
Brace = 3
Column = 1
Null = 4
Other = 5

eFramePropType​

class viktor.external.etabs.enums.eFramePropType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eFramePropType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Angle = 4
Auto = 12
Box = 6
Bridge = 16
BucklingRestrainedBrace = 33
BuiltupICoverplate = 23
BuiltupIHybrid = 26
BuiltupUHybrid = 27
Channel = 2
Circle = 9
Cold_2C = 18
Cold_2L = 21
Cold_Box = 42
Cold_C = 17
Cold_Hat = 22
Cold_I = 43
Cold_L = 20
Cold_Pipe = 44
Cold_T = 45
Cold_Z = 19
ConcreteBox = 36
ConcreteCross = 38
ConcretePipe = 37
ConcreteTee = 35
Concrete_L = 28
CoreBrace_BRB = 34
DbChannel = 11
DblAngle = 5
EncasedCircle = 32
EncasedRectangle = 31
FilledPipe = 30
FilledTube = 29
General = 10
I = 1
Joist = 15
PCCGirderBox = 47
PCCGirderI = 24
PCCGirderSuperT = 41
PCCGirderU = 25
Pipe = 7
Rectangular = 8
SD = 13
SteelPlate = 39
SteelRod = 40
T = 3
Trapezoidal = 46
Variable = 14

eHingeDistributionType​

class viktor.external.etabs.enums.eHingeDistributionType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eHingeDistributionType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ContinuousSupport = 4
DistributedPlasticity = 2
EqualSpacing = 3
NonlinearBeamColumn = 1
UserDefined = 5

eHingeLengthOverwriteType​

class viktor.external.etabs.enums.eHingeLengthOverwriteType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eHingeLengthOverwriteType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Absolute = 2
None_ = 1
Relative = 3

eHingeLocationType​

class viktor.external.etabs.enums.eHingeLocationType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eHingeLocationType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

OffsetFromIEnd = 2
OffsetFromJEnd = 3
RelativeDistance = 1

eItemType​

class viktor.external.etabs.enums.eItemType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eItemType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Group = 1
Objects = 0
SelectedObjects = 2

eItemTypeElm​

class viktor.external.etabs.enums.eItemTypeElm(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eItemTypeElm values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Element = 1
GroupElm = 2
ObjectElm = 0
SelectionElm = 3

eLength​

class viktor.external.etabs.enums.eLength(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eLength values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

NotApplicable = 0
cm = 5
ft = 2
inch = 1
m = 6
micron = 3
mm = 4

eLinkPropType​

class viktor.external.etabs.enums.eLinkPropType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eLinkPropType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Damper = 2
Gap = 3
Hook = 4
Isolator1 = 6
Isolator2 = 7
Isolator3 = 10
Linear = 1
MultilinearElastic = 8
MultilinearPlastic = 9
PlasticWen = 5

eLoadCaseType​

class viktor.external.etabs.enums.eLoadCaseType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eLoadCaseType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Buckling = 10
HyperStatic = 14
LinearDynamic = 7
LinearHistory = 5
LinearStatic = 1
LinearStaticMultiStep = 13
Modal = 3
MovingLoad = 9
NonlinearDynamic = 8
NonlinearHistory = 6
NonlinearStatic = 2
PowerSpectralDensity = 12
ResponseSpectrum = 4
SteadyState = 11

eLoadPatternType​

class viktor.external.etabs.enums.eLoadPatternType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eLoadPatternType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ActiveEarthPressure = 45
Bouyancy = 36
Braking = 15
Centrifugal = 16
Construction = 39
Creep = 29
Dead = 1
DeadManufacture = 42
DeadWater = 41
DeadWearing = 40
DownDrag = 23
EarthHydrostatic = 43
EarthSurcharge = 22
EuroLm1Char = 48
EuroLm1Freq = 49
EuroLm2 = 50
EuroLm3 = 51
EuroLm4 = 52
Friction = 17
HorizontalEarthPressure = 20
Hyperstatic = 35
Ice = 18
Impact = 38
Live = 3
LiveLoadSurcharge = 31
LockedInForces = 32
Move = 9
MoveDeflection = 57
MoveFatigue = 55
MoveFatiguePermit = 56
MoveTrain = 58
Notional = 12
Other = 8
PassiveEarthPressure = 44
PatternAuto = 60
PatternLive = 13
PedestrianLL = 33
PedestrianLLReduced = 46
Permit = 54
Prestress = 34
PrestressTransfer = 59
Quake = 5
QuakeDrift = 61
QuakeVerticalOnly = 62
ReduceLive = 4
Rooflive = 11
SeaState = 53
Settlement = 27
Shrinkage = 28
Snow = 7
SnowHighAltitude = 47
StreamFlow = 37
SuperDead = 2
Temperature = 10
TemperatureGradient = 26
VehicleCollision = 24
VerticalEarthPressure = 21
VesselCollision = 25
WaterloadPressure = 30
Wave = 14
Wind = 6
WindOnLiveLoad = 19

eMatCoupledType​

class viktor.external.etabs.enums.eMatCoupledType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatCoupledType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

FariaConcreteDamagePlasticity = 4
ModifiedDarwinPecknoldConcrete = 3
None_ = 1
VonMisesPlasticity = 2

eMatType​

class viktor.external.etabs.enums.eMatType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Aluminum = 4
ColdFormed = 5
Concrete = 2
Masonry = 8
NoDesign = 3
Rebar = 6
Steel = 1
Tendon = 7

eMatTypeAluminum​

class viktor.external.etabs.enums.eMatTypeAluminum(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatTypeAluminum values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

SubType_5052_H34 = 3
SubType_6061_T6 = 1
SubType_6063_T6 = 2

eMatTypeColdFormed​

class viktor.external.etabs.enums.eMatTypeColdFormed(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatTypeColdFormed values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ASTM_A653SQGr33 = 1
ASTM_A653SQGr50 = 2

eMatTypeConcrete​

class viktor.external.etabs.enums.eMatTypeConcrete(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatTypeConcrete values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Chinese_C20_NormalWeight = 9
Chinese_C30_NormalWeight = 10
Chinese_C40_NormalWeight = 11
EN_C12_NormalWeight = 22
EN_C16_NormalWeight = 23
EN_C20_NormalWeight = 24
EN_C25_NormalWeight = 25
EN_C30_NormalWeight = 26
EN_C35_NormalWeight = 27
EN_C40_NormalWeight = 28
EN_C45_NormalWeight = 29
EN_C50_NormalWeight = 30
EN_C55_NormalWeight = 31
EN_C60_NormalWeight = 32
EN_C70_NormalWeight = 33
EN_C80_NormalWeight = 34
EN_C90_NormalWeight = 35
FC3000_LightWeight = 5
FC3000_NormalWeight = 1
FC4000_LightWeight = 6
FC4000_NormalWeight = 2
FC5000_LightWeight = 7
FC5000_NormalWeight = 3
FC6000_LightWeight = 8
FC6000_NormalWeight = 4
Indian_M15_NormalWeight = 12
Indian_M20_NormalWeight = 13
Indian_M25_NormalWeight = 14
Indian_M30_NormalWeight = 15
Indian_M35_NormalWeight = 16
Indian_M40_NormalWeight = 17
Indian_M45_NormalWeight = 18
Indian_M50_NormalWeight = 19
Indian_M55_NormalWeight = 20
Indian_M60_NormalWeight = 21

eMatTypeRebar​

class viktor.external.etabs.enums.eMatTypeRebar(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatTypeRebar values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ASTM_A615Gr40 = 1
ASTM_A615Gr60 = 2
ASTM_A615Gr75 = 3
ASTM_A706 = 4
Chinese_HPB235 = 5
Chinese_HRB335 = 6
Chinese_HRB400 = 7
Indian_HYSD415 = 9
Indian_HYSD500 = 10
Indian_HYSD550 = 11
Indian_Mild250 = 8

eMatTypeSteel​

class viktor.external.etabs.enums.eMatTypeSteel(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatTypeSteel values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ASTM_A36 = 1
ASTM_A500GrB_Fy42 = 3
ASTM_A500GrB_Fy46 = 4
ASTM_A53GrB = 2
ASTM_A572Gr50 = 5
ASTM_A913Gr50 = 6
ASTM_A992_Fy50 = 7
Chinese_Q235 = 8
Chinese_Q345 = 9
Chinese_Q355 = 16
EN100252_S235 = 12
EN100252_S275 = 13
EN100252_S355 = 14
EN100252_S450 = 15
Indian_Fe250 = 10
Indian_Fe345 = 11

eMatTypeTendon​

class viktor.external.etabs.enums.eMatTypeTendon(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eMatTypeTendon values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

ASTM_A416Gr250 = 1
ASTM_A416Gr270 = 2

eNamedSetType​

class viktor.external.etabs.enums.eNamedSetType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eNamedSetType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

All = 0
BridgeCalculationReport = 17
BridgeCalculationReportSub = 18
BridgeSeismicReport = 15
BridgeSuperstructureResponse = 16
JointTHResponseSpectra = 8
NamedDisplay = 9
PlotFunctionTraces = 10
PushoverCurve = 11
RunAnalysis = 2
RunBridgeDesignSeismic = 5
RunBridgeDesignSubstructure = 4
RunBridgeDesignSuperstructure = 3
RunBridgeRatingSuperstructure = 6
RunMemberRating = 7
TableGroupSuperset = 14
TableSet = 13
UpdateBridgeObject = 1
VirtualWork = 12

eObjType​

class viktor.external.etabs.enums.eObjType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eObjType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Area = 3
Frame = 2
Point = 1
Solid = 6

eReturnCode​

class viktor.external.etabs.enums.eReturnCode(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eReturnCode values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Deprecated = -98
NoError = 0
NotApplicable = -100
NotImplemented = -99
TableDoesNotExist = -96
TableIsObsolete = -97
UnspecifiedError = 1

eShellType​

class viktor.external.etabs.enums.eShellType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eShellType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Layered = 6
Membrane = 3
PlateThick_DO_NOT_USE = 5
PlateThin_DO_NOT_USE = 4
ShellThick = 2
ShellThin = 1

eSlabType​

class viktor.external.etabs.enums.eSlabType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eSlabType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Drop = 1
Footing = 6
Mat = 5
Ribbed = 3
Slab = 0
Stiff_DO_NOT_USE = 2
Waffle = 4

eSolidPropFormulationType​

class viktor.external.etabs.enums.eSolidPropFormulationType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eSolidPropFormulationType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

LegacyQuadratic = 1
LegacyStandard = 0
Quadratic = 3
Standard = 2

eSuperObjectClass​

class viktor.external.etabs.enums.eSuperObjectClass(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eSuperObjectClass values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

BridgeFoundation = 3
Foundation = 2
None_ = 0
SuperObject = 1

eTemperature​

class viktor.external.etabs.enums.eTemperature(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eTemperature values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

C = 2
F = 1
NotApplicable = 0

eTemplateType​

class viktor.external.etabs.enums.eTemplateType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eTemplateType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Advanced = 17
Barrel = 12
Beam = 2
BracedFrame = 7
Bridge = 11
BridgeWizard = 23
CableBridges = 29
Clear = 1
Cylinder = 13
Dome = 14
EccentricFrame = 8
Floor = 16
Frame2D = 21
Frame3D = 22
Grid = 0
PerimeterFrame = 9
PipesAndPlates = 24
PortalFrame = 6
ShearWall = 15
Shells = 25
SlopedTruss = 3
SolidModels = 26
SpaceFrame = 10
SpaceTruss = 5
Staircases = 28
StorageStructures = 27
Truss2D = 19
Truss3D = 20
UndergoundConcrete = 18
VerticalTruss = 4

eUnits​

class viktor.external.etabs.enums.eUnits(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eUnits values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

N_cm_C = 15
N_m_C = 10
N_mm_C = 9
Ton_cm_C = 16
Ton_m_C = 12
Ton_mm_C = 11
kN_cm_C = 13
kN_m_C = 6
kN_mm_C = 5
kgf_cm_C = 14
kgf_m_C = 8
kgf_mm_C = 7
kip_ft_F = 4
kip_in_F = 3
lb_ft_F = 2
lb_in_F = 1

eWallPierRebarLayerType​

class viktor.external.etabs.enums.eWallPierRebarLayerType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eWallPierRebarLayerType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Confinement_EndZoneI = 5
Confinement_EndZoneJ = 6
Diagonal_Each = 7
Horizontal_Distributed_MiddleZone_Eachface = 2
Vertical_Distributed_EndZoneI_Total = 3
Vertical_Distributed_EndZoneJ_Total = 4
Vertical_Distributed_MiddleZone_Eachface = 1

eWallPropType​

class viktor.external.etabs.enums.eWallPropType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eWallPropType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

AutoSelectList = 2
Specified = 1

eWallSpandrelRebarLayerType​

class viktor.external.etabs.enums.eWallSpandrelRebarLayerType(*values)

Bases: IntEnum

New in 14.31.0

ETABS OAPI eWallSpandrelRebarLayerType values, mirroring the CSiAPIv1 names so code reads like the OAPI docs.

Diagonal_Each = 5
Horizontal_Bottom_Total = 2
Horizontal_Distributed_Eachface = 3
Horizontal_Top_Total = 1
Vertical_Ties_Distributed = 4