cFrameObjGetLoadTemperature Method

Retrieves the temperature load assignments to frame objects.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetLoadTemperature(
	string Name,
	ref int NumberItems,
	ref string[] FrameName,
	ref string[] LoadPat,
	ref int[] MyType,
	ref double[] Val,
	ref string[] PatternName,
	eItemType ItemType = eItemType.Objects
)

Parameters

Name
Type: SystemString
The name of an existing frame object or group, depending on the value of the ItemType item.
NumberItems
Type: SystemInt32
The total number of temperature loads retrieved for the specified frame objects.
FrameName
Type: SystemString
This is an array that includes the name of the frame object associated with each temperature load.
LoadPat
Type: SystemString
This is an array that includes the name of the load pattern associated with each temperature load.
MyType
Type: SystemInt32
This is an array that includes 1, 2 or 3, indicating the type of temperature load.
  1. Temperature
  2. Temperature gradient along local 2 axis
  3. Temperature gradient along local 3 axis
Val
Type: SystemDouble
PatternName
Type: SystemString
This is an array that includes the joint pattern name, if any, used to specify the temperature load.
ItemType (Optional)
Type: ETABS2016eItemType
This is one of the following items in the eItemType enumeration:
  • Object = 0
  • Group = 1
  • SelectedObjects = 2

If this item is Objects, the assignments are retrieved for the frame object specified by the Name item.

If this item is Group, the assignments are retrieved for all frame objects in the group specified by the Name item.

If this item is SelectedObjects, the assignments are retrieved for all selected frame objects and the Name item is ignored.

Return Value

Type: Int32
Returns zero if the load assignments are successfully retrieved, otherwise it returns a nonzero value.
Remarks
Examples
VB
Copy
Public Sub Example()
   Dim SapModel As cSapModel
   Dim EtabsObject As cOAPI
   Dim ret As Integer = -1
   Dim NumberItems As Integer
   Dim FrameName() As String
   Dim LoadPat() As String
   Dim MyType() As Integer
   Dim Val() As Double
   Dim PatternName() 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)

'assign frame temperature load
   ret = SapModel.FrameObj.SetLoadTemperature("All", "DEAD", 1, 50, , , eItemType.Group)

'get frame temperature load
   ret = SapModel.FrameObj.GetLoadTemperature("ALL", NumberItems, FrameName, LoadPat, MyType, Val, PatternName, eItemType.Group)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing

End Sub
See Also