SetDiaphragm Method

cPointObj SetDiaphragm Method

CSi API ETABS 2015

Assigns a diaphragm to a point object

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

Syntax

int SetDiaphragm(
	string Name,
	eDiaphragmOption DiaphragmOption,
	string DiaphragmName = ""
)

int SetDiaphragm(
	string Name,
	eDiaphragmOption DiaphragmOption,
	string DiaphragmName = ""
)

Function SetDiaphragm ( _
	Name As String, _
	DiaphragmOption As eDiaphragmOption, _
	Optional DiaphragmName As String = "" _
) As Integer

Function SetDiaphragm ( _
	Name As String, _
	DiaphragmOption As eDiaphragmOption, _
	Optional DiaphragmName As String = "" _
) As Integer

int SetDiaphragm(
	String^ Name, 
	eDiaphragmOption DiaphragmOption, 
	String^ DiaphragmName = L""
)

int SetDiaphragm(
	String^ Name, 
	eDiaphragmOption DiaphragmOption, 
	String^ DiaphragmName = L""
)

Parameters

Name: Type: System String
The name of an existing point object

DiaphragmOption: Type: ETABS2015 eDiaphragmOption
This is an item from the eDiaphragmOption enumeration
If this item is Disconnect then the point object will be disconnected from any diaphragm
If this item is FromShellObject then the point object will inherit the diaphragm assignment of its bounding area object.
If this item is DefinedDiaphragm then the point object will be assigned the existing diaphragm specified by DiaphragmName

DiaphragmName (Optional): Type: System String
The name of an existing diaphragm

Return Value

Returns zero if the diaphragm assignment is successfully made, 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 DiaphragmOption As ETABS2013.eDiaphragmOption
       Dim DiaphragmName 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)

   'define a new diaphragm
       ret = SapModel.Diaphragm.SetDiaphragm("MyDiaph1A", True)

   'assign diaphragm to point
       ret = SapModel.PointObj.SetDiaphragm("1", ETABS2013.eDiaphragmOption.DefinedDiaphragm, "MyDiaph1A")

   'get point diaphragm assignment
      ret = SapModel.PointObj.GetDiaphragm("1", DiaphragmOption, DiaphragmName)

   '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 DiaphragmOption As ETABS2013.eDiaphragmOption
       Dim DiaphragmName 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)

   'define a new diaphragm
       ret = SapModel.Diaphragm.SetDiaphragm("MyDiaph1A", True)

   'assign diaphragm to point
       ret = SapModel.PointObj.SetDiaphragm("1", ETABS2013.eDiaphragmOption.DefinedDiaphragm, "MyDiaph1A")

   'get point diaphragm assignment
      ret = SapModel.PointObj.GetDiaphragm("1", DiaphragmOption, DiaphragmName)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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