AddByCoord Method

cAreaObj AddByCoord Method

CSi API ETABS 2015

Adds a new area object, defining points at the specified coordinates.

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

Syntax

int AddByCoord(
	int NumberPoints,
	ref double[] X,
	ref double[] Y,
	ref double[] Z,
	ref string Name,
	string PropName = "Default",
	string UserName = "",
	string CSys = "Global"
)

int AddByCoord(
	int NumberPoints,
	ref double[] X,
	ref double[] Y,
	ref double[] Z,
	ref string Name,
	string PropName = "Default",
	string UserName = "",
	string CSys = "Global"
)

Function AddByCoord ( _
	NumberPoints As Integer, _
	ByRef X As Double(), _
	ByRef Y As Double(), _
	ByRef Z As Double(), _
	ByRef Name As String, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "", _
	Optional CSys As String = "Global" _
) As Integer

Function AddByCoord ( _
	NumberPoints As Integer, _
	ByRef X As Double(), _
	ByRef Y As Double(), _
	ByRef Z As Double(), _
	ByRef Name As String, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "", _
	Optional CSys As String = "Global" _
) As Integer

int AddByCoord(
	int NumberPoints, 
	array<double>^% X, 
	array<double>^% Y, 
	array<double>^% Z, 
	String^% Name, 
	String^ PropName = L"Default", 
	String^ UserName = L"", 
	String^ CSys = L"Global"
)

int AddByCoord(
	int NumberPoints, 
	array<double>^% X, 
	array<double>^% Y, 
	array<double>^% Z, 
	String^% Name, 
	String^ PropName = L"Default", 
	String^ UserName = L"", 
	String^ CSys = L"Global"
)

Parameters

NumberPoints: Type: System Int32
The number of points in the area object.

X: Type: System Double

Y: Type: System Double

Z: Type: System Double

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

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

UserName (Optional): Type: System String

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

Return Value

Returns zero if the area 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 x() As Double 
   Dim y() As Double 
   Dim z() As Double 
   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()

'create blank template model
   ret = SapModel.File.NewBlank()

'add area object by coordinates 
   ReDim x(5)
   ReDim y(5)
   ReDim z(5)
   x(0) = 50:   y(0) = 0
   x(1) = 100:  y(1) = 0
   x(2) = 150:  y(2) = 40
   x(3) = 100:  y(3) = 80
   x(4) = 50:   y(4) = 80
   x(5) = 0:    y(5) = 40
   ret = SapModel.AreaObj.AddByCoord(6, x, y, z, Name)

'refresh view
   ret = SapModel.View.RefreshView(0, False)

'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 x() As Double 
   Dim y() As Double 
   Dim z() As Double 
   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()

'create blank template model
   ret = SapModel.File.NewBlank()

'add area object by coordinates 
   ReDim x(5)
   ReDim y(5)
   ReDim z(5)
   x(0) = 50:   y(0) = 0
   x(1) = 100:  y(1) = 0
   x(2) = 150:  y(2) = 40
   x(3) = 100:  y(3) = 80
   x(4) = 50:   y(4) = 80
   x(5) = 0:    y(5) = 40
   ret = SapModel.AreaObj.AddByCoord(6, x, y, z, Name)

'refresh view
   ret = SapModel.View.RefreshView(0, False)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing 

End Sub