SetStories Method

cStory SetStories Method

CSi API ETABS 2015

Sets the stories for the current tower

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

Syntax

int SetStories(
	string[] StoryNames,
	double[] StoryElevations,
	double[] StoryHeights,
	bool[] IsMasterStory,
	string[] SimilarToStory,
	bool[] SpliceAbove,
	double[] SpliceHeight
)

int SetStories(
	string[] StoryNames,
	double[] StoryElevations,
	double[] StoryHeights,
	bool[] IsMasterStory,
	string[] SimilarToStory,
	bool[] SpliceAbove,
	double[] SpliceHeight
)

Function SetStories ( _
	StoryNames As String(), _
	StoryElevations As Double(), _
	StoryHeights As Double(), _
	IsMasterStory As Boolean(), _
	SimilarToStory As String(), _
	SpliceAbove As Boolean(), _
	SpliceHeight As Double() _
) As Integer

Function SetStories ( _
	StoryNames As String(), _
	StoryElevations As Double(), _
	StoryHeights As Double(), _
	IsMasterStory As Boolean(), _
	SimilarToStory As String(), _
	SpliceAbove As Boolean(), _
	SpliceHeight As Double() _
) As Integer

int SetStories(
	array<String^>^ StoryNames, 
	array<double>^ StoryElevations, 
	array<double>^ StoryHeights, 
	array<bool>^ IsMasterStory, 
	array<String^>^ SimilarToStory, 
	array<bool>^ SpliceAbove, 
	array<double>^ SpliceHeight
)

int SetStories(
	array<String^>^ StoryNames, 
	array<double>^ StoryElevations, 
	array<double>^ StoryHeights, 
	array<bool>^ IsMasterStory, 
	array<String^>^ SimilarToStory, 
	array<bool>^ SpliceAbove, 
	array<double>^ SpliceHeight
)

Parameters

StoryNames: Type: System String
The names of the stories

StoryElevations: Type: System Double
The story elevations. This array has length (Number of stories + 1). The first value in the array is the "Base" elevation, commonly 0.

StoryHeights: Type: System Double
The story heights. Although this argument is not optional, an empty array may be used. This array has length (Number of stories), with no value for "Base"

IsMasterStory: Type: System Boolean
Whether the story is a master story. This array has length (Number of stories), with no value for "Base"

SimilarToStory: Type: System String
If the story is not a master story, which master story the story is similar to. This array has length (Number of stories), with no value for "Base"

SpliceAbove: Type: System Boolean
This is True if the story has a splice height, and False otherwise. This array has length (Number of stories), with no value for "Base"

SpliceHeight: Type: System Double
The story splice heights, if applicable. This array has length (Number of stories), with no value for "Base"

Return Value

Returns zero if the story data is successfully set, otherwise returns nonzero.

Remarks

To change the current tower, use SetActiveTower(String)

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim NumberStories As Integer 
       Dim StoryNames() As String 
       Dim StoryHeights() As Double 
       Dim StoryElevations() As Double 
       Dim IsMasterStory() As Boolean 
       Dim SimilarToStory() As String 
       Dim SpliceAbove() As Boolean 
       Dim SpliceHeight() As Double 

   '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)

   'set stories 
       Dim inStoryNames As String() = {"MyStory1", "MyStory2", "MyStory3", "MyStory4", "MyStory5", "MyStory6"}
       Dim inStoryElevations As Double() = {0, 5, 15, 23, 23.5, 40, 50}
       Dim inStoryHeights As Double() = {2, 5, 7, 33, 1, 9}
       Dim inIsMasterStory As Boolean() = {False, False, False, False, False, True}
       Dim inSimilarToStory As String() = {"None", "", "MyStory6", "MyStory6", "MyStory6", "MyStory6"}
       Dim inSpliceAbove As Boolean() = {False, True, False, True, False, True}
       Dim inSpliceHeight As Double() = {0, 0, 2, 2, 0, 1}

       ret = SapModel.Story.SetStories(inStoryNames, inStoryElevations, inStoryHeights, _
                                   inIsMasterStory, inSimilarToStory, inSpliceAbove, inSpliceHeight)

   'get stories
       ret = SapModel.Story.GetStories(NumberStories, StoryNames, StoryHeights, StoryElevations, _
                                   IsMasterStory, SimilarToStory, SpliceAbove, SpliceHeight)

   '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 NumberStories As Integer 
       Dim StoryNames() As String 
       Dim StoryHeights() As Double 
       Dim StoryElevations() As Double 
       Dim IsMasterStory() As Boolean 
       Dim SimilarToStory() As String 
       Dim SpliceAbove() As Boolean 
       Dim SpliceHeight() As Double 

   '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)

   'set stories 
       Dim inStoryNames As String() = {"MyStory1", "MyStory2", "MyStory3", "MyStory4", "MyStory5", "MyStory6"}
       Dim inStoryElevations As Double() = {0, 5, 15, 23, 23.5, 40, 50}
       Dim inStoryHeights As Double() = {2, 5, 7, 33, 1, 9}
       Dim inIsMasterStory As Boolean() = {False, False, False, False, False, True}
       Dim inSimilarToStory As String() = {"None", "", "MyStory6", "MyStory6", "MyStory6", "MyStory6"}
       Dim inSpliceAbove As Boolean() = {False, True, False, True, False, True}
       Dim inSpliceHeight As Double() = {0, 0, 2, 2, 0, 1}

       ret = SapModel.Story.SetStories(inStoryNames, inStoryElevations, inStoryHeights, _
                                   inIsMasterStory, inSimilarToStory, inSpliceAbove, inSpliceHeight)

   'get stories
       ret = SapModel.Story.GetStories(NumberStories, StoryNames, StoryHeights, StoryElevations, _
                                   IsMasterStory, SimilarToStory, SpliceAbove, SpliceHeight)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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