Skip to content

Heet docstring changes #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Aug 16, 2022
Merged

Heet docstring changes #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9938db0
docstring_changes
heetrojivadiya Jul 20, 2022
4eb8476
docstringChanges
heetrojivadiya Jul 28, 2022
8d0af7e
docstr Changes
heetrojivadiya Jul 29, 2022
5cec2dc
Docstring_Changes
heetrojivadiya Aug 2, 2022
f762972
update docstring
heetrojivadiya Aug 2, 2022
f6dee43
Update member.py
heetrojivadiya Aug 2, 2022
8edb6c3
Updated
heetrojivadiya Aug 4, 2022
5c9ef01
changes_loads
heetrojivadiya Aug 5, 2022
bbd35dd
Update
heetrojivadiya Aug 8, 2022
1e814bb
updated_docstr
heetrojivadiya Aug 9, 2022
1af629b
Merge branch 'main' into heet-docstring_changes
heetrojivadiya Aug 16, 2022
c1dd915
fixed 2 tests
Aug 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions RFEM/BasicObjects/line.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ def __init__(self,
nodes_no (str): Nodes Defining Line
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -54,6 +55,7 @@ def Polyline(
nodes_no (str): Nodes Defining Polyline
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -100,6 +102,7 @@ def Arc(
alpha_adjustment_target (enum): Line Arc Alpha Adjustment Target Enumeration
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -146,12 +149,12 @@ def Circle(
'''
Args:
no (int): Line Tag
nodes_no (str): Nodes on Line of Circle
center_of_circle (list): Cartesian Co-Ordinates of Circle Centre [X, Y, Z]
circle_radius (float): Magnitude of Circle Radius
point_of_normal_to_circle_plane (list): Vector from Circle Centre to this Point [X, Y, Z] defines Vector Normal to Circle Plane
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -210,6 +213,7 @@ def EllipticalArc(
arc_angle_beta (float): Beta Arc Angle (in Radians)
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -266,6 +270,7 @@ def Ellipse(
ellipse_control_point (list): Ellipse Control Point [X, Y, Z]
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -304,7 +309,7 @@ def Ellipse(
@staticmethod
def Parabola(
no: int = 1,
nodes_no: str = [3,8],
nodes_no: list = [3,8],
parabola_control_point: list = [10,-3,0],
parabola_alpha: float = 0,
comment: str = '',
Expand All @@ -318,6 +323,7 @@ def Parabola(
parabola_alpha (float): Alpha Angle (in Radians)
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -368,6 +374,7 @@ def Spline(
nodes_no (str): Node Tags on Line of Spline
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -409,12 +416,13 @@ def NURBS(
'''
Args:
no (int): Line Tag
nodes_no (str): Nodes creating the curve. By default theese are taken as control points.
nodes_no (str): Nodes creating the curve. By default these are taken as control points.
control_points (list of lists, optional): Nested List of Respective Control Point's Cartesian Co-Ordinates
weights (list, optional): Control points weights e.g. [1,1,1]
order (int, optional): Order of the curve with 3 as default value
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line
Expand Down Expand Up @@ -467,6 +475,7 @@ def DeleteLine(lines_no: str = '1 2', model = Model):
'''
Args:
lines_no (str): Numbers of Lines to be deleted
model (RFEM Class, optional): Model to be edited
'''

# Delete from client model
Expand Down
3 changes: 3 additions & 0 deletions RFEM/BasicObjects/lineSet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ def __init__(self,
line_set_type (enum): Line Set Type Enumeration
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line Set
Expand Down Expand Up @@ -59,6 +60,7 @@ def ContinuousLines(
lines_no (str): Numbers of Lines Contained Within Continuous Line Set
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line Set
Expand Down Expand Up @@ -101,6 +103,7 @@ def GroupOfLines(
lines_no (str): Numbers of Lines Contained Within Group of Lines Line Set
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Line Set
Expand Down
2 changes: 2 additions & 0 deletions RFEM/BasicObjects/material.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ def __init__(self,
name (str): Name of Desired Material (As Named in RFEM Database)
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Material
Expand Down Expand Up @@ -47,6 +48,7 @@ def DeleteMaterial(materials_no: str = '1 2', model = Model):
'''
Args:
materials_no (str): Numbers of Materials to be deleted
model (RFEM Class, optional): Model to be edited
'''

# Delete from client model
Expand Down
16 changes: 12 additions & 4 deletions RFEM/BasicObjects/member.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def __init__(self,
Args:
no (int): Member Tag
start_node_no (int): Tag of Start Node
end_node_no (int,): Tag of End Node
end_node_no (int): Tag of End Node
rotation_angle (float): Member Rotation Angle
start_section_no (int): Tag of Start Section
end_section_no (int): Tag of End Section
Expand Down Expand Up @@ -140,8 +140,8 @@ def Beam(
rotation_parameters = [rotation_surface, rotation_surface_plane_type]
start_section_no (int): Tag of Start Section
end_section_no (int): End of End Section
line (int, optional): Assigned Line
distribution_parameters (list): Distribution Parameters
line (int, optional): Assigned Line
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
"""
Expand Down Expand Up @@ -367,7 +367,7 @@ def Rigid(
rotation_specification_type (enum): Rotation Specification Type Enumeration
rotation_parameters (list): Rotation Parameters
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_ANGLE:
rotation_parameters = [rotation_angle]
rotation_parameters = [rotation_angle]
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_HELP_NODE:
rotation_parameters = [rotation_help_node, rotation_plane_type]
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_INSIDE_NODE:
Expand Down Expand Up @@ -614,7 +614,7 @@ def Truss(
rotation_specification_type (enum): Rotation Specification Type Enumeration
rotation_parameters (list): Rotation Parameters
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_ANGLE:
rotation_parameters = [rotation_angle]
rotation_parameters = [rotation_angle]
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_HELP_NODE:
rotation_parameters = [rotation_help_node, rotation_plane_type]
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_INSIDE_NODE:
Expand Down Expand Up @@ -1336,6 +1336,7 @@ def ResultBeam(
end_node_no (int,): Tag of End Node
section_distribution_type (enum): Section Distribution Type Enumeration
rotation_specification_type (enum): Rotation Specification Type Enumeration
result_beam_integrate_stresses_and_forces (enum): Member Result Beam Integration Enumeration
rotation_parameters (list): Rotation Parameters
for rotation_specification_type == MemberRotationSpecificationType.COORDINATE_SYSTEM_ROTATION_VIA_ANGLE:
rotation_parameters = [rotation_angle]
Expand Down Expand Up @@ -1377,6 +1378,7 @@ def ResultBeam(
integration_parameters = [result_beam_radius]
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
"""
# Client model | Member
clientObject = model.clientModel.factory.create('ns0:member')
Expand Down Expand Up @@ -1597,6 +1599,7 @@ def DefinableStiffness(
definable_stiffness (int): Definable Stiffness Tag
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
"""
# Client model | Member
clientObject = model.clientModel.factory.create('ns0:member')
Expand Down Expand Up @@ -1699,6 +1702,7 @@ def CouplingRigidRigid(
rotation_parameters = [rotation_surface, rotation_surface_plane_type]
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
"""
# Client model | Member
clientObject = model.clientModel.factory.create('ns0:member')
Expand Down Expand Up @@ -1777,6 +1781,7 @@ def CouplingRigidHinge(
rotation_parameters = [rotation_surface, rotation_surface_plane_type]
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
"""
# Client model | Member
clientObject = model.clientModel.factory.create('ns0:member')
Expand Down Expand Up @@ -1855,6 +1860,7 @@ def CouplingHingeRigid(
rotation_parameters = [rotation_surface, rotation_surface_plane_type]
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
"""
# Client model | Member
clientObject = model.clientModel.factory.create('ns0:member')
Expand Down Expand Up @@ -1933,6 +1939,7 @@ def CouplingHingeHinge(
rotation_parameters = [rotation_surface, rotation_surface_plane_type]
comment (str, optional): Comment
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
"""
# Client model | Member
clientObject = model.clientModel.factory.create('ns0:member')
Expand Down Expand Up @@ -1990,6 +1997,7 @@ def DeleteMember(members_no: str = '1 2', model = Model):
'''
Args:
members_no (str): Numbers of Members to be deleted
model (RFEM Class, optional): Model to be edited
'''

# Delete from client model
Expand Down
3 changes: 3 additions & 0 deletions RFEM/BasicObjects/memberSet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ def __init__(self,
member_set_type (enum): Member Set Type Enumeration
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Member Set
Expand Down Expand Up @@ -59,6 +60,7 @@ def ContinuousMembers(
members_no (str): Numbers of Members Contained Within Continuous Member Set
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Member Set
Expand Down Expand Up @@ -101,6 +103,7 @@ def GroupOfmembers(
members_no (str): Numbers of Members Contained Within Group of Members Member Set
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Member Set
Expand Down
22 changes: 15 additions & 7 deletions RFEM/BasicObjects/node.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ def __init__(self,
coordinate_Z (float): Z-Coordinate
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''
# Client model | Node
clientObject = model.clientModel.factory.create('ns0:node')
Expand Down Expand Up @@ -74,6 +75,7 @@ def Standard(
coordinate_system_type (enum): Coordinate System Type Enumeration
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Node
Expand Down Expand Up @@ -160,16 +162,17 @@ def BetweenTwoNodes(
start_node_no (int): Start Node
end_node_no (int): End Node
node_reference (enum): Node Reference Enumeration
length_between_i_and_j (int): Length between 2 Nodes
length_between_i_and_j (float): Length between 2 Nodes
parameters (list):
if distance_from_start_relative:
parameters = [True, %]
if distance_from_start_absolute:
parameters = [False, magnitude]
offset_y (int): Offset in Y-Direction
offset_z (int): Offset in Z-Direction
offset_y (float): Offset in Y-Direction
offset_z (float): Offset in Z-Direction
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Node
Expand Down Expand Up @@ -251,10 +254,11 @@ def BetweenTwoPoints(
parameters = [True, %]
if distance_from_start_absolute:
parameters = [False, magnitude]
offset_y (int): Offset in Y-Direction
offset_z (int): Offset in Z-Direction
offset_y (float): Offset in Y-Direction
offset_z (float): Offset in Z-Direction
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Node
Expand Down Expand Up @@ -317,17 +321,19 @@ def OnLine(
model = Model):

'''
Args:
Args:
no (int): Node Tag
line_number (int): Line Tag
node_reference (enum): Node Reference Enumeration
length_between_i_and_j (int): Length between 2 Nodes
length_between_i_and_j (float): Length between 2 Nodes
parameters (list):
if distance_from_start_relative:
parameters = [True, %]
if distance_from_start_absolute:
parameters = [False, magnitude]
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Node
Expand Down Expand Up @@ -392,6 +398,7 @@ def OnMember(
parameters = [False, magnitude]
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Node
Expand Down Expand Up @@ -438,6 +445,7 @@ def DeleteNode(nodes_no: str = '1 2', model = Model):
'''
Args:
nodes_no (str): Numbers of Nodes to be deleted
model (RFEM Class, optional): Model to be edited
'''

# Delete from client model
Expand Down
2 changes: 2 additions & 0 deletions RFEM/BasicObjects/opening.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ def __init__(self,
lines_no (str): Numbers of Lines defining Opening
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (RFEM Class, optional): Model to be edited
'''

# Client model | Opening
Expand Down Expand Up @@ -46,6 +47,7 @@ def DeleteOpening(openings_no: str = '1 2', model = Model):
'''
Args:
openings_no (str): Numbers of Openings to be deleted
model (RFEM Class, optional): Model to be edited
'''

# Delete from client model
Expand Down
3 changes: 2 additions & 1 deletion RFEM/BasicObjects/section.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def __init__(self,
material_no (int): Tag of Material assigned to Section
comment (str, optional): Comments
params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
model (class, optional): Model instance
model (RFEM Class, optional): Model to be edited
'''

# Client model | Section
Expand Down Expand Up @@ -52,6 +52,7 @@ def DeleteSection(sections_no: str = '1 2', model = Model):
'''
Args:
sections_no (str): Numbers of Sections to be deleted
model (RFEM Class, optional): Model to be edited
'''

# Delete from client model
Expand Down
Loading