AddByCoord Method

cFrameObj AddByCoord Method

CSi API ETABS 2015

Adds a new frame object whose end points are at the specified coordinates.

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

Syntax

int AddByCoord(
	double XI,
	double YI,
	double ZI,
	double XJ,
	double YJ,
	double ZJ,
	ref string Name,
	string PropName = "Default",
	string UserName = "",
	string CSys = "Global"
)

int AddByCoord(
	double XI,
	double YI,
	double ZI,
	double XJ,
	double YJ,
	double ZJ,
	ref string Name,
	string PropName = "Default",
	string UserName = "",
	string CSys = "Global"
)

Function AddByCoord ( _
	XI As Double, _
	YI As Double, _
	ZI As Double, _
	XJ As Double, _
	YJ As Double, _
	ZJ As Double, _
	ByRef Name As String, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "", _
	Optional CSys As String = "Global" _
) As Integer

Function AddByCoord ( _
	XI As Double, _
	YI As Double, _
	ZI As Double, _
	XJ As Double, _
	YJ As Double, _
	ZJ As Double, _
	ByRef Name As String, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "", _
	Optional CSys As String = "Global" _
) As Integer

int AddByCoord(
	double XI, 
	double YI, 
	double ZI, 
	double XJ, 
	double YJ, 
	double ZJ, 
	String^% Name, 
	String^ PropName = L"Default", 
	String^ UserName = L"", 
	String^ CSys = L"Global"
)

int AddByCoord(
	double XI, 
	double YI, 
	double ZI, 
	double XJ, 
	double YJ, 
	double ZJ, 
	String^% Name, 
	String^ PropName = L"Default", 
	String^ UserName = L"", 
	String^ CSys = L"Global"
)

Parameters

XI: Type: System Double
The coordinates of the I-End of the added frame object. The coordinates are in the coordinate system defined by the CSys item.

YI: Type: System Double

ZI: Type: System Double

XJ: Type: System Double

YJ: Type: System Double

ZJ: Type: System Double

Name: Type: System String
This is the name that the program ultimately assigns for the frame object. If no userName is specified, the program assigns a default name to the frame object. If a userName is specified and that name is not used for another frame, cable or tendon object, the userName is assigned to the frame object, otherwise a default name is assigned to the frame object.

PropName (Optional): Type: System String
This is Default, None, or the name of a defined frame section property.
If it is Default, the program assigns a default section property to the frame object. If it is None, no section property is assigned to the frame object. If it is the name of a defined frame section property, that property is assigned to the frame object.

UserName (Optional): Type: System String

CSys (Optional): Type: System String
The name of the coordinate system in which the frame object end point coordinates are defined.

Return Value

Returns zero if the frame object is successfully added, 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 Name 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(ETABS2013.eUnits.lb_ft_F)

'create steel deck template model
   ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

'add frame object by coordinates
   ret = SapModel.FrameObj.AddByCoord(0, 72, 48, 0, 48, 36, Name)

'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 Name 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(ETABS2013.eUnits.lb_ft_F)

'create steel deck template model
   ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

'add frame object by coordinates
   ret = SapModel.FrameObj.AddByCoord(0, 72, 48, 0, 48, 36, Name)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing 

End Sub