pytabs.story

  1# pyTABS - ETABS .NET API python wrapper
  2# Story - cStory interface 
  3__all__ = ['Story']
  4
  5# import etabs namespace and error handler
  6from pytabs.etabs import *
  7from pytabs.error_handle import *
  8
  9# import typing
 10from typing import Union
 11
 12
 13class Story:
 14    """Story interface"""
 15    def __init__(self, sap_model : cSapModel) -> None:
 16        # link of SapModel interface
 17        self.sap_model = sap_model
 18        # create PierLabel interface
 19        self.story = cStory(self.sap_model.Story)
 20        
 21        
 22    def get_elevation(self, story_name : str) -> float:
 23        """Retrieves the elevation of a defined story.
 24
 25        :param story_name: name of a defined story
 26        :type story_name: str
 27        :return: elevation of the story
 28        :rtype: float
 29        """
 30        elevation = float()
 31        [ret, elevation] = self.story.GetElevation(story_name, elevation)
 32        handle(ret)
 33        return elevation
 34    
 35    
 36    def get_height(self, story_name : str) -> float:
 37        """Retrieves the height of a defined story.
 38
 39        :param story_name: name of a defined story
 40        :type story_name: str
 41        :return: height of the story
 42        :rtype: float
 43        """
 44        height = float()
 45        [ret, height] = self.story.GetHeight(story_name, height)
 46        handle(ret)
 47        return height
 48    
 49    
 50    def get_master_story(self, story_name : str) -> bool:
 51        """Retrieves whether a defined story is a master story.
 52
 53        :param story_name: name of a defined story
 54        :type story_name: str
 55        :return: True if the story is a master story, False otherwise
 56        :rtype: bool
 57        """
 58        is_master_story = bool()
 59        [ret, is_master_story] = self.story.GetMasterStory(story_name, is_master_story)
 60        handle(ret)
 61        return is_master_story
 62    
 63    
 64    def get_name_list(self) -> list[str]:
 65        """Retrieves the names of all defined stories.
 66
 67        :return: all story names
 68        :rtype: list[str]
 69        """
 70        number_names = int()
 71        story_names = ['']
 72        [ret, number_names, story_names] = self.story.GetNameList(number_names, story_names)
 73        handle(ret)
 74        return list(story_names)
 75    
 76    
 77    def get_similar_to(self, story_name : str) -> Union[str, None]:
 78        """Retrieves whether a defined story is a master story.
 79
 80        :param story_name: name of a defined story
 81        :type story_name: str
 82        :return: name of similar story, if story is master returns None
 83        :rtype: Union[str, None]
 84        """
 85        is_master = bool()
 86        similar_story = str()
 87        [ret, is_master, similar_story] = self.story.GetSimilarTo(story_name, is_master, similar_story)
 88        handle(ret)
 89        if not is_master:
 90            return similar_story
 91    
 92    
 93    def get_splice(self, story_name : str) -> Union[float, None]:
 94        """Retrieves the story splice height, if applicable.
 95
 96        :param story_name: name of a defined story
 97        :type story_name: str
 98        :return: height of splice, if present otherwise None
 99        :rtype: Union[float, None]
100        """
101        splice_above = bool()
102        splice_height = float()
103        [ret, splice_above, splice_height] = self.story.GetSplice(story_name, splice_above, splice_height)
104        handle(ret)
105        if splice_above:
106            return splice_height
class Story:
 14class Story:
 15    """Story interface"""
 16    def __init__(self, sap_model : cSapModel) -> None:
 17        # link of SapModel interface
 18        self.sap_model = sap_model
 19        # create PierLabel interface
 20        self.story = cStory(self.sap_model.Story)
 21        
 22        
 23    def get_elevation(self, story_name : str) -> float:
 24        """Retrieves the elevation of a defined story.
 25
 26        :param story_name: name of a defined story
 27        :type story_name: str
 28        :return: elevation of the story
 29        :rtype: float
 30        """
 31        elevation = float()
 32        [ret, elevation] = self.story.GetElevation(story_name, elevation)
 33        handle(ret)
 34        return elevation
 35    
 36    
 37    def get_height(self, story_name : str) -> float:
 38        """Retrieves the height of a defined story.
 39
 40        :param story_name: name of a defined story
 41        :type story_name: str
 42        :return: height of the story
 43        :rtype: float
 44        """
 45        height = float()
 46        [ret, height] = self.story.GetHeight(story_name, height)
 47        handle(ret)
 48        return height
 49    
 50    
 51    def get_master_story(self, story_name : str) -> bool:
 52        """Retrieves whether a defined story is a master story.
 53
 54        :param story_name: name of a defined story
 55        :type story_name: str
 56        :return: True if the story is a master story, False otherwise
 57        :rtype: bool
 58        """
 59        is_master_story = bool()
 60        [ret, is_master_story] = self.story.GetMasterStory(story_name, is_master_story)
 61        handle(ret)
 62        return is_master_story
 63    
 64    
 65    def get_name_list(self) -> list[str]:
 66        """Retrieves the names of all defined stories.
 67
 68        :return: all story names
 69        :rtype: list[str]
 70        """
 71        number_names = int()
 72        story_names = ['']
 73        [ret, number_names, story_names] = self.story.GetNameList(number_names, story_names)
 74        handle(ret)
 75        return list(story_names)
 76    
 77    
 78    def get_similar_to(self, story_name : str) -> Union[str, None]:
 79        """Retrieves whether a defined story is a master story.
 80
 81        :param story_name: name of a defined story
 82        :type story_name: str
 83        :return: name of similar story, if story is master returns None
 84        :rtype: Union[str, None]
 85        """
 86        is_master = bool()
 87        similar_story = str()
 88        [ret, is_master, similar_story] = self.story.GetSimilarTo(story_name, is_master, similar_story)
 89        handle(ret)
 90        if not is_master:
 91            return similar_story
 92    
 93    
 94    def get_splice(self, story_name : str) -> Union[float, None]:
 95        """Retrieves the story splice height, if applicable.
 96
 97        :param story_name: name of a defined story
 98        :type story_name: str
 99        :return: height of splice, if present otherwise None
100        :rtype: Union[float, None]
101        """
102        splice_above = bool()
103        splice_height = float()
104        [ret, splice_above, splice_height] = self.story.GetSplice(story_name, splice_above, splice_height)
105        handle(ret)
106        if splice_above:
107            return splice_height

Story interface

Story(sap_model: ETABSv1.cSapModel)
16    def __init__(self, sap_model : cSapModel) -> None:
17        # link of SapModel interface
18        self.sap_model = sap_model
19        # create PierLabel interface
20        self.story = cStory(self.sap_model.Story)
def get_elevation(self, story_name: str) -> float:
23    def get_elevation(self, story_name : str) -> float:
24        """Retrieves the elevation of a defined story.
25
26        :param story_name: name of a defined story
27        :type story_name: str
28        :return: elevation of the story
29        :rtype: float
30        """
31        elevation = float()
32        [ret, elevation] = self.story.GetElevation(story_name, elevation)
33        handle(ret)
34        return elevation

Retrieves the elevation of a defined story.

Parameters
  • story_name: name of a defined story
Returns

elevation of the story

def get_height(self, story_name: str) -> float:
37    def get_height(self, story_name : str) -> float:
38        """Retrieves the height of a defined story.
39
40        :param story_name: name of a defined story
41        :type story_name: str
42        :return: height of the story
43        :rtype: float
44        """
45        height = float()
46        [ret, height] = self.story.GetHeight(story_name, height)
47        handle(ret)
48        return height

Retrieves the height of a defined story.

Parameters
  • story_name: name of a defined story
Returns

height of the story

def get_master_story(self, story_name: str) -> bool:
51    def get_master_story(self, story_name : str) -> bool:
52        """Retrieves whether a defined story is a master story.
53
54        :param story_name: name of a defined story
55        :type story_name: str
56        :return: True if the story is a master story, False otherwise
57        :rtype: bool
58        """
59        is_master_story = bool()
60        [ret, is_master_story] = self.story.GetMasterStory(story_name, is_master_story)
61        handle(ret)
62        return is_master_story

Retrieves whether a defined story is a master story.

Parameters
  • story_name: name of a defined story
Returns

True if the story is a master story, False otherwise

def get_name_list(self) -> list[str]:
65    def get_name_list(self) -> list[str]:
66        """Retrieves the names of all defined stories.
67
68        :return: all story names
69        :rtype: list[str]
70        """
71        number_names = int()
72        story_names = ['']
73        [ret, number_names, story_names] = self.story.GetNameList(number_names, story_names)
74        handle(ret)
75        return list(story_names)

Retrieves the names of all defined stories.

Returns

all story names

def get_similar_to(self, story_name: str) -> Optional[str]:
78    def get_similar_to(self, story_name : str) -> Union[str, None]:
79        """Retrieves whether a defined story is a master story.
80
81        :param story_name: name of a defined story
82        :type story_name: str
83        :return: name of similar story, if story is master returns None
84        :rtype: Union[str, None]
85        """
86        is_master = bool()
87        similar_story = str()
88        [ret, is_master, similar_story] = self.story.GetSimilarTo(story_name, is_master, similar_story)
89        handle(ret)
90        if not is_master:
91            return similar_story

Retrieves whether a defined story is a master story.

Parameters
  • story_name: name of a defined story
Returns

name of similar story, if story is master returns None

def get_splice(self, story_name: str) -> Optional[float]:
 94    def get_splice(self, story_name : str) -> Union[float, None]:
 95        """Retrieves the story splice height, if applicable.
 96
 97        :param story_name: name of a defined story
 98        :type story_name: str
 99        :return: height of splice, if present otherwise None
100        :rtype: Union[float, None]
101        """
102        splice_above = bool()
103        splice_height = float()
104        [ret, splice_above, splice_height] = self.story.GetSplice(story_name, splice_above, splice_height)
105        handle(ret)
106        if splice_above:
107            return splice_height

Retrieves the story splice height, if applicable.

Parameters
  • story_name: name of a defined story
Returns

height of splice, if present otherwise None