HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.ZoneJointContainer Class Reference

Represents an entity that contains a collection of Zones and Joints. More...

Inheritance diagram for hyperx.api.ZoneJointContainer:
hyperx.api.IdNameEntityRenameable hyperx.api.IdNameEntity hyperx.api.IdEntity hyperx.api.Set hyperx.api.Structure

Public Member Functions

 __init__ (self, _api.ZoneJointContainer zoneJointContainer)
CollectionModificationStatus AddJoint (self, int id)
CollectionModificationStatus AddJoint (self, item1=None)
CollectionModificationStatus AddJoint (self, Joint joint)
CollectionModificationStatus AddPanelSegment (self, int id)
CollectionModificationStatus AddPanelSegment (self, item1=None)
CollectionModificationStatus AddPanelSegment (self, PanelSegment segment)
CollectionModificationStatus AddZone (self, int id)
CollectionModificationStatus AddZone (self, item1=None)
CollectionModificationStatus AddZone (self, Zone zone)
CollectionModificationStatus AddZones (self, item1=None)
CollectionModificationStatus AddZones (self, tuple[int] ids)
CollectionModificationStatus AddZones (self, tuple[Zone] zones)
CollectionModificationStatus RemoveJoint (self, int id)
CollectionModificationStatus RemoveJoint (self, item1=None)
CollectionModificationStatus RemoveJoint (self, Joint joint)
CollectionModificationStatus RemoveJoints (self, item1=None)
CollectionModificationStatus RemoveJoints (self, JointCol joints)
CollectionModificationStatus RemoveJoints (self, tuple[int] jointIds)
CollectionModificationStatus RemovePanelSegment (self, int id)
CollectionModificationStatus RemovePanelSegment (self, item1=None)
CollectionModificationStatus RemovePanelSegment (self, PanelSegment segment)
CollectionModificationStatus RemovePanelSegments (self, item1=None)
CollectionModificationStatus RemovePanelSegments (self, PanelSegmentCol segments)
CollectionModificationStatus RemovePanelSegments (self, tuple[int] segmentIds)
CollectionModificationStatus RemoveZone (self, int id)
CollectionModificationStatus RemoveZone (self, item1=None)
CollectionModificationStatus RemoveZone (self, Zone zone)
CollectionModificationStatus RemoveZones (self, item1=None)
CollectionModificationStatus RemoveZones (self, tuple[int] zoneIds)
CollectionModificationStatus RemoveZones (self, ZoneCol zones)
Public Member Functions inherited from hyperx.api.IdNameEntityRenameable
 __init__ (self, _api.IdNameEntityRenameable idNameEntityRenameable)
None Rename (self, str name)
Public Member Functions inherited from hyperx.api.IdNameEntity
 __init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
 __init__ (self, _api.IdEntity idEntity)

Properties

 Centroid = property
 Joints = property
 PanelSegments = property
 TotalBeamLength = property
 TotalPanelArea = property
 TotalZoneWeight = property
 Zones = property
Properties inherited from hyperx.api.IdNameEntity
 Name = property
Properties inherited from hyperx.api.IdEntity
 Id = property

Additional Inherited Members

Protected Attributes inherited from hyperx.api.IdEntity
 _Entity = idEntity

Detailed Description

Represents an entity that contains a collection of Zones and Joints.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.ZoneJointContainer.__init__ ( self,
_api.ZoneJointContainer zoneJointContainer )

Member Function Documentation

◆ AddJoint() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddJoint ( self,
int id )

◆ AddJoint() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddJoint ( self,
item1 = None )

◆ AddJoint() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddJoint ( self,
Joint joint )

◆ AddPanelSegment() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddPanelSegment ( self,
int id )

◆ AddPanelSegment() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddPanelSegment ( self,
item1 = None )

◆ AddPanelSegment() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddPanelSegment ( self,
PanelSegment segment )

◆ AddZone() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZone ( self,
int id )

◆ AddZone() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZone ( self,
item1 = None )

◆ AddZone() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZone ( self,
Zone zone )

◆ AddZones() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZones ( self,
item1 = None )

◆ AddZones() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZones ( self,
tuple[int] ids )

◆ AddZones() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZones ( self,
tuple[Zone] zones )

◆ RemoveJoint() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveJoint ( self,
int id )

◆ RemoveJoint() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveJoint ( self,
item1 = None )

◆ RemoveJoint() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveJoint ( self,
Joint joint )

◆ RemoveJoints() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveJoints ( self,
item1 = None )

◆ RemoveJoints() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveJoints ( self,
JointCol joints )

◆ RemoveJoints() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveJoints ( self,
tuple[int] jointIds )

◆ RemovePanelSegment() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemovePanelSegment ( self,
int id )

◆ RemovePanelSegment() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemovePanelSegment ( self,
item1 = None )

◆ RemovePanelSegment() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemovePanelSegment ( self,
PanelSegment segment )

◆ RemovePanelSegments() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemovePanelSegments ( self,
item1 = None )

◆ RemovePanelSegments() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemovePanelSegments ( self,
PanelSegmentCol segments )

◆ RemovePanelSegments() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemovePanelSegments ( self,
tuple[int] segmentIds )

◆ RemoveZone() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveZone ( self,
int id )

◆ RemoveZone() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveZone ( self,
item1 = None )

◆ RemoveZone() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveZone ( self,
Zone zone )

◆ RemoveZones() [1/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveZones ( self,
item1 = None )

◆ RemoveZones() [2/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveZones ( self,
tuple[int] zoneIds )

◆ RemoveZones() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.RemoveZones ( self,
ZoneCol zones )

Property Documentation

◆ Centroid

hyperx.api.ZoneJointContainer.Centroid = property
static

◆ Joints

hyperx.api.ZoneJointContainer.Joints = property
static

◆ PanelSegments

hyperx.api.ZoneJointContainer.PanelSegments = property
static

◆ TotalBeamLength

hyperx.api.ZoneJointContainer.TotalBeamLength = property
static

◆ TotalPanelArea

hyperx.api.ZoneJointContainer.TotalPanelArea = property
static

◆ TotalZoneWeight

hyperx.api.ZoneJointContainer.TotalZoneWeight = property
static

◆ Zones

hyperx.api.ZoneJointContainer.Zones = property
static

The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py