JointReact Method

cAnalysisResults JointReact Method

CSi API ETABS 2015

Reports the joint reactions for the specified point elements. The reactions reported are from restraints, springs and grounded (one-joint) links.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

C++

Copy to Clipboard Print

int JointReact(
	string Name,
	eItemTypeElm ItemTypeElm,
	ref int NumberResults,
	ref string[] Obj,
	ref string[] Elm,
	ref string[] LoadCase,
	ref string[] StepType,
	ref double[] StepNum,
	ref double[] F1,
	ref double[] F2,
	ref double[] F3,
	ref double[] M1,
	ref double[] M2,
	ref double[] M3
)

int JointReact(
	string Name,
	eItemTypeElm ItemTypeElm,
	ref int NumberResults,
	ref string[] Obj,
	ref string[] Elm,
	ref string[] LoadCase,
	ref string[] StepType,
	ref double[] StepNum,
	ref double[] F1,
	ref double[] F2,
	ref double[] F3,
	ref double[] M1,
	ref double[] M2,
	ref double[] M3
)

Function JointReact ( _
	Name As String, _
	ItemTypeElm As eItemTypeElm, _
	ByRef NumberResults As Integer, _
	ByRef Obj As String(), _
	ByRef Elm As String(), _
	ByRef LoadCase As String(), _
	ByRef StepType As String(), _
	ByRef StepNum As Double(), _
	ByRef F1 As Double(), _
	ByRef F2 As Double(), _
	ByRef F3 As Double(), _
	ByRef M1 As Double(), _
	ByRef M2 As Double(), _
	ByRef M3 As Double() _
) As Integer

Function JointReact ( _
	Name As String, _
	ItemTypeElm As eItemTypeElm, _
	ByRef NumberResults As Integer, _
	ByRef Obj As String(), _
	ByRef Elm As String(), _
	ByRef LoadCase As String(), _
	ByRef StepType As String(), _
	ByRef StepNum As Double(), _
	ByRef F1 As Double(), _
	ByRef F2 As Double(), _
	ByRef F3 As Double(), _
	ByRef M1 As Double(), _
	ByRef M2 As Double(), _
	ByRef M3 As Double() _
) As Integer

int JointReact(
	String^ Name, 
	eItemTypeElm ItemTypeElm, 
	int% NumberResults, 
	array<String^>^% Obj, 
	array<String^>^% Elm, 
	array<String^>^% LoadCase, 
	array<String^>^% StepType, 
	array<double>^% StepNum, 
	array<double>^% F1, 
	array<double>^% F2, 
	array<double>^% F3, 
	array<double>^% M1, 
	array<double>^% M2, 
	array<double>^% M3
)

int JointReact(
	String^ Name, 
	eItemTypeElm ItemTypeElm, 
	int% NumberResults, 
	array<String^>^% Obj, 
	array<String^>^% Elm, 
	array<String^>^% LoadCase, 
	array<String^>^% StepType, 
	array<double>^% StepNum, 
	array<double>^% F1, 
	array<double>^% F2, 
	array<double>^% F3, 
	array<double>^% M1, 
	array<double>^% M2, 
	array<double>^% M3
)

Parameters

Name: Type: System String
The name of an existing point object, point element, or group of objects depending on the value of the ItemTypeElm item.

ItemTypeElm: Type: ETABS2015 eItemTypeElm
This is one of the following items in the eItemTypeElm enumeration.
If this item is ObjectElm, the result request is for the point element corresponding to the point object specified by the Name item.
If this item is Element, the result request is for the point element specified by the Name item.
If this item is GroupElm, the result request is for all point elements directly or indirectly specified in the group specified by the Name item.
If this item is SelectionElm, the result request is for all point elements directly or indirectly selected and the Name item is ignored.

NumberResults: Type: System Int32
The total number of results returned by the program.

Obj: Type: System String

Elm: Type: System String

LoadCase: Type: System String
This is an array that includes the name of the analysis case or load combination associated with each result.

StepType: Type: System String
This is an array that includes the step type, if any, for each result.

StepNum: Type: System Double
This is an array that includes the step number, if any, for each result.

F1: Type: System Double

F2: Type: System Double
This is a one dimensional array that includes the reaction forces in the point element local 2 axis direction. [F].

F3: Type: System Double
This is a one dimensional array that includes the reaction forces in the point element local 3 axis direction. [F].

M1: Type: System Double
This is a one dimensional array that includes the reaction moments about the point element local 1 axis direction. [FL].

M2: Type: System Double
This is a one dimensional array that includes the reaction moments about the point element local 2 axis direction. [FL].

M3: Type: System Double
This is a one dimensional array that includes the reaction moments about the point element local 3 axis direction. [FL].

Return Value

Returns zero if the reactions are successfully recovered; otherwise it returns a nonzero value.

Remarks

See Results for more information.

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim NumberResults As Integer 
       Dim Obj() As String 
       Dim Elm() As String 
       Dim LoadCase() As String 
       Dim StepType() As String 
       Dim StepNum() As Double 
       Dim F1() As Double 
       Dim F2() As Double 
       Dim F3() As Double 
       Dim M1() As Double 
       Dim M2() As Double 
       Dim M3() As Double 

   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'run analysis
       System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
       ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
       ret = SapModel.Analyze.RunAnalysis

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get point displacements
       ret = SapModel.Results.JointReact("1", ETABS2013.eItemTypeElm.Element, NumberResults, Obj, Elm, LoadCase, StepType, StepNum, F1, F2, F3, M1, M2, M3)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim NumberResults As Integer 
       Dim Obj() As String 
       Dim Elm() As String 
       Dim LoadCase() As String 
       Dim StepType() As String 
       Dim StepNum() As Double 
       Dim F1() As Double 
       Dim F2() As Double 
       Dim F3() As Double 
       Dim M1() As Double 
       Dim M2() As Double 
       Dim M3() As Double 

   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'run analysis
       System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
       ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
       ret = SapModel.Analyze.RunAnalysis

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get point displacements
       ret = SapModel.Results.JointReact("1", ETABS2013.eItemTypeElm.Element, NumberResults, Obj, Elm, LoadCase, StepType, StepNum, F1, F2, F3, M1, M2, M3)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub