GetHook Method

cPropLink GetHook Method

CSi API ETABS 2015

Retrieves link property data for a hook-type link property.

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

Syntax

int GetHook(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref bool[] Nonlinear,
	ref double[] Ke,
	ref double[] Ce,
	ref double[] K,
	ref double[] Dis,
	ref double DJ2,
	ref double DJ3,
	ref string Notes,
	ref string GUID
)

int GetHook(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref bool[] Nonlinear,
	ref double[] Ke,
	ref double[] Ce,
	ref double[] K,
	ref double[] Dis,
	ref double DJ2,
	ref double DJ3,
	ref string Notes,
	ref string GUID
)

Function GetHook ( _
	Name As String, _
	ByRef DOF As Boolean(), _
	ByRef Fixed As Boolean(), _
	ByRef Nonlinear As Boolean(), _
	ByRef Ke As Double(), _
	ByRef Ce As Double(), _
	ByRef K As Double(), _
	ByRef Dis As Double(), _
	ByRef DJ2 As Double, _
	ByRef DJ3 As Double, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

Function GetHook ( _
	Name As String, _
	ByRef DOF As Boolean(), _
	ByRef Fixed As Boolean(), _
	ByRef Nonlinear As Boolean(), _
	ByRef Ke As Double(), _
	ByRef Ce As Double(), _
	ByRef K As Double(), _
	ByRef Dis As Double(), _
	ByRef DJ2 As Double, _
	ByRef DJ3 As Double, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

int GetHook(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<bool>^% Nonlinear, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	array<double>^% K, 
	array<double>^% Dis, 
	double% DJ2, 
	double% DJ3, 
	String^% Notes, 
	String^% GUID
)

int GetHook(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<bool>^% Nonlinear, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	array<double>^% K, 
	array<double>^% Dis, 
	double% DJ2, 
	double% DJ3, 
	String^% Notes, 
	String^% GUID
)

Parameters

Name: Type: System String
The name of an existing hook-type link property.

DOF: Type: System Boolean

Fixed

Type:

System Boolean
This is a boolean array, dimensioned to 5, indicating if the specified degree of freedom is fixed (restrained).

Value	Fixity
Fixed(0)	U1 fixity if DOF(0) = True
Fixed(1)	U2 fixity if DOF(1) = True
Fixed(2)	U3 fixity if DOF(2) = True
Fixed(3)	R1 fixity if DOF(3) = True
Fixed(4)	R2 fixity if DOF(4) = True
Fixed(5)	R3 fixity if DOF(5) = True

Nonlinear

Type:

System Boolean
This is a boolean array, dimensioned to 5, indicating if nonlinear properties exist for a specified degree of freedom.

Value	Nonlinear
Nonlinear(0)	U1 has nonlinear properties
Nonlinear(1)	U2 has nonlinear properties
Nonlinear(2)	U3 has nonlinear properties
Nonlinear(3)	R1 has nonlinear properties
Nonlinear(4)	R2 has nonlinear properties
Nonlinear(5)	R3 has nonlinear properties

The term Nonlinear(n) applies only when DOF(n) = True and Fixed(n) = False.

Ke: Type: System Double

Ce: Type: System Double

K: Type: System Double

Dis: Type: System Double

DJ2: Type: System Double

DJ3: Type: System Double

Notes: Type: System String

GUID: Type: System String
The GUID (global unique identifier), if any, assigned to the property. If this item is input as Default, the program assigns a GUID to the property.

Return Value

Returns zero if the property is successfully retrieved; otherwise it returns a nonzero value

Remarks

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim MyDOF() As Boolean 
       Dim MyFixed() As Boolean 
       Dim MyNonLinear() as Boolean 
       Dim MyKe() As Double 
       Dim MyCe() As Double 
       Dim MyK() As Double 
       Dim MyDis() As Double 
       Dim DOF() As Boolean 
       Dim Fixed() As Boolean 
       Dim NonLinear() as Boolean 
       Dim Ke() As Double 
       Dim Ce() As Double 
       Dim K() As Double 
       Dim Dis() As Double 
       Dim dj2 As Double 
       Dim dj3 As Double 
       Dim Notes As String 
       Dim GUID As String 

   '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)

   'add link property 
       ReDim MyDOF(5)
       ReDim MyFixed(5)
       ReDim MyNonLinear(5)
       ReDim MyKe(5)
       ReDim MyCe(5)
       ReDim MyK(5)
       ReDim MyDis(5)

       MyDOF(0) = True
       MyKe(0) = 12
       MyCe(0) = 0.01

       MyDOF(1) = True
       MyNonLinear(1) = True
       MyKe(1) = 12
       MyCe(1) = 0.01
       MyK(1) = 20
       MyDis(1) = 1.2

       MyDOF(2) = True
       MyFixed(2) = True

       ret = SapModel.PropLink.SetGap("G1", MyDOF, MyFixed, MyNonLinear, MyKe, MyCe, MyK, MyDis, 2, 0)

   'get link property data
       ret = SapModel.PropLink.GetGap("G1", DOF, Fixed, NonLinear, Ke, Ce, k, dis, dj2, dj3, Notes, GUID)

   '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 MyDOF() As Boolean 
       Dim MyFixed() As Boolean 
       Dim MyNonLinear() as Boolean 
       Dim MyKe() As Double 
       Dim MyCe() As Double 
       Dim MyK() As Double 
       Dim MyDis() As Double 
       Dim DOF() As Boolean 
       Dim Fixed() As Boolean 
       Dim NonLinear() as Boolean 
       Dim Ke() As Double 
       Dim Ce() As Double 
       Dim K() As Double 
       Dim Dis() As Double 
       Dim dj2 As Double 
       Dim dj3 As Double 
       Dim Notes As String 
       Dim GUID As String 

   '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)

   'add link property 
       ReDim MyDOF(5)
       ReDim MyFixed(5)
       ReDim MyNonLinear(5)
       ReDim MyKe(5)
       ReDim MyCe(5)
       ReDim MyK(5)
       ReDim MyDis(5)

       MyDOF(0) = True
       MyKe(0) = 12
       MyCe(0) = 0.01

       MyDOF(1) = True
       MyNonLinear(1) = True
       MyKe(1) = 12
       MyCe(1) = 0.01
       MyK(1) = 20
       MyDis(1) = 1.2

       MyDOF(2) = True
       MyFixed(2) = True

       ret = SapModel.PropLink.SetGap("G1", MyDOF, MyFixed, MyNonLinear, MyKe, MyCe, MyK, MyDis, 2, 0)

   'get link property data
       ret = SapModel.PropLink.GetGap("G1", DOF, Fixed, NonLinear, Ke, Ce, k, dis, dj2, dj3, Notes, GUID)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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