pytabs.point_obj

 1# pyTABS - ETABS .NET API python wrapper
 2# PointObj - cPointObj
 3__all__ = ['PointObj']
 4
 5# import ETABS namespace and pyTABS error handler
 6from pytabs.etabs_config import *
 7from pytabs.error_handle import *
 8
 9# import custom enumerations
10
11
12# import typing
13
14
15class PointObj:
16    """PointObj interface"""
17    def __init__(self, sap_model : etabs.cSapModel) -> None:
18        # link of SapModel interface
19        self.sap_model = sap_model
20        # create PointObj interface
21        self.point_obj = etabs.cPointObj(sap_model.PointObj)
22        
23        # relate relevant ETABS enumerations
24        self.eDiaphragmOption = etabs.eDiaphragmOption
25        """EtabsModel `DiaphragmOption` enumeration"""
26        
27
28        # relate custom enumerations
29        
30        
31        
32    def get_name_from_label (self, label : str, story : str) -> str:
33        """Retrieves the unique name of a point object, given the label and story level.
34
35        :param label: The point object label 
36        :type label: str
37        :param story: The point object story level  
38        :type label: str
39        :return point_name: The unique name of the point object
40        :rtype: str
41        """
42
43        point_name = str()
44        [ret, point_name] = self.point_obj.GetNameFromLabel(label, story, point_name) 
45        handle(ret)
46        return point_name
class PointObj:
16class PointObj:
17    """PointObj interface"""
18    def __init__(self, sap_model : etabs.cSapModel) -> None:
19        # link of SapModel interface
20        self.sap_model = sap_model
21        # create PointObj interface
22        self.point_obj = etabs.cPointObj(sap_model.PointObj)
23        
24        # relate relevant ETABS enumerations
25        self.eDiaphragmOption = etabs.eDiaphragmOption
26        """EtabsModel `DiaphragmOption` enumeration"""
27        
28
29        # relate custom enumerations
30        
31        
32        
33    def get_name_from_label (self, label : str, story : str) -> str:
34        """Retrieves the unique name of a point object, given the label and story level.
35
36        :param label: The point object label 
37        :type label: str
38        :param story: The point object story level  
39        :type label: str
40        :return point_name: The unique name of the point object
41        :rtype: str
42        """
43
44        point_name = str()
45        [ret, point_name] = self.point_obj.GetNameFromLabel(label, story, point_name) 
46        handle(ret)
47        return point_name

PointObj interface

PointObj(sap_model: ETABSv1.cSapModel)
18    def __init__(self, sap_model : etabs.cSapModel) -> None:
19        # link of SapModel interface
20        self.sap_model = sap_model
21        # create PointObj interface
22        self.point_obj = etabs.cPointObj(sap_model.PointObj)
23        
24        # relate relevant ETABS enumerations
25        self.eDiaphragmOption = etabs.eDiaphragmOption
26        """EtabsModel `DiaphragmOption` enumeration"""
27        
28
29        # relate custom enumerations
eDiaphragmOption

EtabsModel DiaphragmOption enumeration

def get_name_from_label(self, label: str, story: str) -> str:
33    def get_name_from_label (self, label : str, story : str) -> str:
34        """Retrieves the unique name of a point object, given the label and story level.
35
36        :param label: The point object label 
37        :type label: str
38        :param story: The point object story level  
39        :type label: str
40        :return point_name: The unique name of the point object
41        :rtype: str
42        """
43
44        point_name = str()
45        [ret, point_name] = self.point_obj.GetNameFromLabel(label, story, point_name) 
46        handle(ret)
47        return point_name

Retrieves the unique name of a point object, given the label and story level.

Parameters
  • label: The point object label
  • story: The point object story level
Returns

The unique name of the point object