AddByCoord Method

cLinkObj AddByCoord Method

CSi API ETABS 2015

Adds a new link 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,
	bool IsSingleJoint = false,
	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,
	bool IsSingleJoint = false,
	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 IsSingleJoint As Boolean = False, _
	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 IsSingleJoint As Boolean = False, _
	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, 
	bool IsSingleJoint = false, 
	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, 
	bool IsSingleJoint = false, 
	String^ PropName = L"Default", 
	String^ UserName = L"", 
	String^ CSys = L"Global"
)

Parameters

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

YI: Type: System Double
The Y coordinate of the I-End of the added link object in the coordinate system defined by the CSys item.

ZI: Type: System Double
The Z coordinate of the I-End of the added link object in the coordinate system defined by the CSys item.

XJ: Type: System Double
The X coordinate of the J-End of the added link object in the coordinate system defined by the CSys item.

YJ: Type: System Double
The Y coordinate of the J-End of the added link object in the coordinate system defined by the CSys item.

ZJ: Type: System Double
The Z coordinate of the J-End of the added link object in the coordinate system defined by the CSys item.

Name: Type: System String
This is the name that the program ultimately assigns for the link object. If no UserName is specified, the program assigns a default name to the link object. If a UserName is specified and that name is not used for another link object, the UserName is assigned to the link object; otherwise a default name is assigned to the link object.

IsSingleJoint (Optional): Type: System Boolean
This item is True if a one-joint link is added and False if a two-joint link is added.

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

UserName (Optional): Type: System String

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

Return Value

Returns zero if the link object is successfully added; otherwise it returns a nonzero value.

Remarks

One-joint links are not supported in ETABS.

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim Name1 As String 
       Dim Name2 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)

   'add link object by coordinates
       ret = SapModel.LinkObj.AddByCoord(-288, 0, 288, 0, 0, 0, Name1, True)
       ret = SapModel.LinkObj.AddByCoord(-288, 0, 0, 0, 0, 144, Name2)

   'refresh view
       ret = SapModel.View.RefreshView

   '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 Name1 As String 
       Dim Name2 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)

   'add link object by coordinates
       ret = SapModel.LinkObj.AddByCoord(-288, 0, 288, 0, 0, 0, Name1, True)
       ret = SapModel.LinkObj.AddByCoord(-288, 0, 0, 0, 0, 144, Name2)

   'refresh view
       ret = SapModel.View.RefreshView

   'close ETABS
       EtabsObject.ApplicationExit(False)

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