SetSpring Method

cPointObj SetSpring Method

CSi API ETABS 2015

Assigns coupled springs to a point object.

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

Syntax

int SetSpring(
	string Name,
	ref double[] K,
	eItemType ItemType = eItemType.Objects,
	bool IsLocalCSys = true,
	bool Replace = false
)

int SetSpring(
	string Name,
	ref double[] K,
	eItemType ItemType = eItemType.Objects,
	bool IsLocalCSys = true,
	bool Replace = false
)

Function SetSpring ( _
	Name As String, _
	ByRef K As Double(), _
	Optional ItemType As eItemType = eItemType.Objects, _
	Optional IsLocalCSys As Boolean = True, _
	Optional Replace As Boolean = False _
) As Integer

Function SetSpring ( _
	Name As String, _
	ByRef K As Double(), _
	Optional ItemType As eItemType = eItemType.Objects, _
	Optional IsLocalCSys As Boolean = True, _
	Optional Replace As Boolean = False _
) As Integer

int SetSpring(
	String^ Name, 
	array<double>^% K, 
	eItemType ItemType = eItemType::Objects, 
	bool IsLocalCSys = true, 
	bool Replace = false
)

int SetSpring(
	String^ Name, 
	array<double>^% K, 
	eItemType ItemType = eItemType::Objects, 
	bool IsLocalCSys = true, 
	bool Replace = false
)

Parameters

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

K: Type: System Double

ItemType (Optional)

Type: ETABS2015 eItemType
This is one of the following items in the eItemType enumeration:

Object = 0
Group = 1
SelectedObjects = 2

If this item is Object, the spring assignment is made to the point object specified by the Name item.

If this item is Group, the spring assignment is made to all point objects in the group specified by the Name item.

If this item is SelectedObjects, the spring assignment is made to all selected point objects and the Name item is ignored.

IsLocalCSys (Optional): Type: System Boolean
If this item is True, the specified spring assignments are in the point object local coordinate system. If it is False, the assignments are in the Global coordinate system.

Replace (Optional): Type: System Boolean
If this item is True, all existing point spring assignments to the specified point object(s) are deleted prior to making the assignment. If it is False, the spring assignments are added to any existing assignments.

Return Value

Returns zero if the stiffnesses are successfully assigned, 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 

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

   'assign spring to a point 
       ReDim k(5)
       k(2) = 10
       ret = SapModel.PointObj.SetSpring("3", k)

   'get spring values 
       ReDim k(5)
       ret = SapModel.PointObj.GetSpring("3", k)

   '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 

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

   'assign spring to a point 
       ReDim k(5)
       k(2) = 10
       ret = SapModel.PointObj.SetSpring("3", k)

   'get spring values 
       ReDim k(5)
       ret = SapModel.PointObj.GetSpring("3", k)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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