SetTCLimits Method

cFrameObj SetTCLimits Method

CSi API ETABS 2015

Makes tension/compression force limit assignments to frame objects.

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

Syntax

int SetTCLimits(
	string Name,
	bool LimitCompressionExists,
	double LimitCompression,
	bool LimitTensionExists,
	double LimitTension,
	eItemType ItemType = eItemType.Objects
)

int SetTCLimits(
	string Name,
	bool LimitCompressionExists,
	double LimitCompression,
	bool LimitTensionExists,
	double LimitTension,
	eItemType ItemType = eItemType.Objects
)

Function SetTCLimits ( _
	Name As String, _
	LimitCompressionExists As Boolean, _
	LimitCompression As Double, _
	LimitTensionExists As Boolean, _
	LimitTension As Double, _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

Function SetTCLimits ( _
	Name As String, _
	LimitCompressionExists As Boolean, _
	LimitCompression As Double, _
	LimitTensionExists As Boolean, _
	LimitTension As Double, _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

int SetTCLimits(
	String^ Name, 
	bool LimitCompressionExists, 
	double LimitCompression, 
	bool LimitTensionExists, 
	double LimitTension, 
	eItemType ItemType = eItemType::Objects
)

int SetTCLimits(
	String^ Name, 
	bool LimitCompressionExists, 
	double LimitCompression, 
	bool LimitTensionExists, 
	double LimitTension, 
	eItemType ItemType = eItemType::Objects
)

Parameters

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

LimitCompressionExists: Type: System Boolean
This item is True if a compression force limit exists for the frame object.

LimitCompression: Type: System Double
The compression force limit for the frame object. [F]

LimitTensionExists: Type: System Boolean
This item is True if a tension force limit exists for the frame object.

LimitTension: Type: System Double
The tension force limit for the frame object. [F]

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 Objects, the assignment is made to the frame object specified by the Name item.

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

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

Return Value

Returns zero if the assignments are successfully applied, otherwise it returns a nonzero value.

Remarks

Note that the tension and compression limits are only used in nonlinear analyses.

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 tension/compression limits
       ret = SapModel.FrameObj.SetTCLimits("1", False, 0, True, 100)

   '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 tension/compression limits
       ret = SapModel.FrameObj.SetTCLimits("1", False, 0, True, 100)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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