SetLinear Method

cPropLink SetLinear Method

CSi API ETABS 2015

Initializes a linear-type link property. If this function is called for an existing link property, all items for the property are reset to their default value.

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

Syntax

C++

Copy to Clipboard Print

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

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

Function SetLinear ( _
	Name As String, _
	ByRef DOF As Boolean(), _
	ByRef Fixed As Boolean(), _
	ByRef Ke As Double(), _
	ByRef Ce As Double(), _
	DJ2 As Double, _
	DJ3 As Double, _
	Optional KeCoupled As Boolean = False, _
	Optional CeCoupled As Boolean = False, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

Function SetLinear ( _
	Name As String, _
	ByRef DOF As Boolean(), _
	ByRef Fixed As Boolean(), _
	ByRef Ke As Double(), _
	ByRef Ce As Double(), _
	DJ2 As Double, _
	DJ3 As Double, _
	Optional KeCoupled As Boolean = False, _
	Optional CeCoupled As Boolean = False, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

int SetLinear(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	double DJ2, 
	double DJ3, 
	bool KeCoupled = false, 
	bool CeCoupled = false, 
	String^ Notes = L"", 
	String^ GUID = L""
)

int SetLinear(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	double DJ2, 
	double DJ3, 
	bool KeCoupled = false, 
	bool CeCoupled = false, 
	String^ Notes = L"", 
	String^ GUID = L""
)

Parameters

Name: Type: System String
The name of an existing or new link property. If this is an existing property, that property is modified; otherwise, a new property is added.

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

The term Fixed(n) applies only when DOF(n) = True

Ke: Type: System Double

Ce: Type: System Double

DJ2: Type: System Double

DJ3: Type: System Double

KeCoupled (Optional): 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 (Optional): 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 (Optional): Type: System String

GUID (Optional): 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 initialized; 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 DOF() As Boolean 
       Dim Fixed() As Boolean 
       Dim Ke() As Double 
       Dim Ce() 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)

   'add link property 
       ReDim DOF(5)
       ReDim Fixed(5)
       ReDim Ke(5)
       ReDim Ce(5)
       DOF(0) = True
       Ke(0) = 12
       ret = SapModel.PropLink.SetLinear("L1", DOF, Fixed, Ke, Ce, 0, 0)

   '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 DOF() As Boolean 
       Dim Fixed() As Boolean 
       Dim Ke() As Double 
       Dim Ce() 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)

   'add link property 
       ReDim DOF(5)
       ReDim Fixed(5)
       ReDim Ke(5)
       ReDim Ce(5)
       DOF(0) = True
       Ke(0) = 12
       ret = SapModel.PropLink.SetLinear("L1", DOF, Fixed, Ke, Ce, 0, 0)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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