IsSpringCoupled {Point Element}

IsSpringCoupled

Syntax

SapObject.SapModel.PointElm.IsSpringCoupled

VB6 Procedure

Function IsSpringCoupled(ByVal Name As String, ByVal IsCoupled As Boolean) As Long

Parameters

Name

The name of an existing point element.

IsCoupled

This item is True if the spring assignment to the specified point element is coupled, otherwise it is False.

Remarks

This function indicates if the spring assignments to a point element are coupled, that is, if there are off-diagonal terms in the 6x6 spring matrix for the point element.

The function returns zero if the coupled status is successfully retrieved, otherwise it returns a nonzero value. If no springs exist at the point object, the function returns a nonzero value.

VBA Example

Sub CheckIsPointElmSpringCoupled()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim k() As Double

Dim IsCoupled As Boolean

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 3, 124, 3, 200)

'assign spring to a point

ReDim k(5)

k(2) = 10

ret = SapModel.PointObj.SetSpring("3", k)

'create analysis model

ret = SapModel.Analyze.CreateAnalysisModel

'determine if point element spring is coupled

ret = SapModel.PointElm.IsSpringCoupled("3", IsCoupled)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also

GetSpring

GetSpringCoupled