GetLinear Method

cPropLink GetLinear Method

CSi API ETABS 2015

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

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

Syntax

int GetLinear(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref double[] Ke,
	ref double[] Ce,
	ref double DJ2,
	ref double DJ3,
	ref bool KeCoupled,
	ref bool CeCoupled,
	ref string Notes,
	ref string GUID
)

int GetLinear(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref double[] Ke,
	ref double[] Ce,
	ref double DJ2,
	ref double DJ3,
	ref bool KeCoupled,
	ref bool CeCoupled,
	ref string Notes,
	ref string GUID
)

Function GetLinear ( _
	Name As String, _
	ByRef DOF As Boolean(), _
	ByRef Fixed As Boolean(), _
	ByRef Ke As Double(), _
	ByRef Ce As Double(), _
	ByRef DJ2 As Double, _
	ByRef DJ3 As Double, _
	ByRef KeCoupled As Boolean, _
	ByRef CeCoupled As Boolean, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

Function GetLinear ( _
	Name As String, _
	ByRef DOF As Boolean(), _
	ByRef Fixed As Boolean(), _
	ByRef Ke As Double(), _
	ByRef Ce As Double(), _
	ByRef DJ2 As Double, _
	ByRef DJ3 As Double, _
	ByRef KeCoupled As Boolean, _
	ByRef CeCoupled As Boolean, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

int GetLinear(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	double% DJ2, 
	double% DJ3, 
	bool% KeCoupled, 
	bool% CeCoupled, 
	String^% Notes, 
	String^% GUID
)

int GetLinear(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	double% DJ2, 
	double% DJ3, 
	bool% KeCoupled, 
	bool% CeCoupled, 
	String^% Notes, 
	String^% GUID
)

Parameters

Name: Type: System String
The name of an existing linear-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

Ke: Type: System Double

Ce: Type: System Double

DJ2: Type: System Double

DJ3: Type: System Double

KeCoupled: Type: System Boolean
This item is True if the link stiffness, Ke, is coupled. There are 21 terms in the Ke array if Ke is coupled; otherwise there are 6 terms

CeCoupled: Type: System Boolean
This item is True if the link damping, Ce, is coupled. There are 21 terms in the Ce array if Ce is coupled; otherwise there are 6 terms

Notes: Type: System String

GUID: Type: System String
The GUID (global unique identifier), if any, assigned to the property.

Return Value

Returns zero if the property data 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 MyKe() As Double 
       Dim MyCe() As Double 
       Dim DOF() As Boolean 
       Dim Fixed() As Boolean 
       Dim Ke() As Double 
       Dim Ce() As Double 
       Dim dj2 As Double 
       Dim dj3 As Double 
       Dim KeCoupled As Boolean 
       Dim CeCoupled As Boolean 
       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 MyKe(5)
       ReDim MyCe(5)
       MyDOF(0) = True
       MyKe(0) = 12
       ret = SapModel.PropLink.SetLinear("L1", MyDOF, MyFixed, MyKe, MyCe, 0, 0)

   'get link property data
       ret = SapModel.PropLink.GetLinear("L1", DOF, Fixed, Ke, Ce, dj2, dj3, KeCoupled, CeCoupled, 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 MyKe() As Double 
       Dim MyCe() As Double 
       Dim DOF() As Boolean 
       Dim Fixed() As Boolean 
       Dim Ke() As Double 
       Dim Ce() As Double 
       Dim dj2 As Double 
       Dim dj3 As Double 
       Dim KeCoupled As Boolean 
       Dim CeCoupled As Boolean 
       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 MyKe(5)
       ReDim MyCe(5)
       MyDOF(0) = True
       MyKe(0) = 12
       ret = SapModel.PropLink.SetLinear("L1", MyDOF, MyFixed, MyKe, MyCe, 0, 0)

   'get link property data
       ret = SapModel.PropLink.GetLinear("L1", DOF, Fixed, Ke, Ce, dj2, dj3, KeCoupled, CeCoupled, Notes, GUID)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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