HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.PanelSegment Class Reference
Inheritance diagram for hyperx.api.PanelSegment:
hyperx.api.ZoneBase hyperx.api.ZoneJointEntity hyperx.api.EntityWithAssignableProperties hyperx.api.IdNameEntityRenameable hyperx.api.IdNameEntity hyperx.api.IdEntity

Public Member Functions

 __init__ (self, _api.PanelSegment panelSegment)
ElementCol GetElements (self, types.DiscreteDefinitionType discreteDefinitionType)
None SetObjectElements (self, types.DiscreteDefinitionType discreteDefinitionType, tuple[int] elementIds)
Public Member Functions inherited from hyperx.api.ZoneBase
 __init__ (self, _api.ZoneBase zoneBase)
AnalysisResultCol GetAllResults (self)
 Obselete.
str GetConceptName (self)
AnalysisResult GetControllingResult (self)
AnalysisResultCol GetControllingResultsPerCriterion (self)
Margin GetMinimumMargin (self)
str GetObjectName (self, types.FamilyObjectUID objectId)
AnalysisResultCol GetResults (self)
 Get all analysis results for this zone.
ZoneDesignResultCol GetZoneDesignResults (self, int solutionId=1)
 Returns a collection of Zone Design Results for a Solution Id (default 1).
ZoneIdUpdateStatus RenumberZone (self, int newId)
 Attempt to update a zone's ID.
Public Member Functions inherited from hyperx.api.ZoneJointEntity
 __init__ (self, _api.ZoneJointEntity zoneJointEntity)
Public Member Functions inherited from hyperx.api.EntityWithAssignableProperties
 __init__ (self, _api.EntityWithAssignableProperties entityWithAssignableProperties)
PropertyAssignmentStatus AssignAnalysisProperty (self, int id)
PropertyAssignmentStatus AssignDesignProperty (self, int id)
PropertyAssignmentStatus AssignLoadProperty (self, int id)
PropertyAssignmentStatus AssignProperty (self, AssignableProperty property)
 Assign a Property to this entity.
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

 DiscreteTechnique = property
 ElementsByObjectOrSkin = property
 Return elements in the object / skin.
 LeftSkinZoneId = property
 Objects = property
 RightSkinZoneId = property
 Skins = property
Properties inherited from hyperx.api.ZoneBase
 AddedWeight = property
 Beam English = lb/ft | Standard = kg/m.
 BucklingImperfection = property
 Centroid = property
 Dmid = property
 Units English = in | Standard = mm.
 EAAuto = property
 Units English = lb | Standard = N.
 EARequired = property
 Units English = lb | Standard = N.
 EI1Auto = property
 Units English = lb/in² | Standard = N/m².
 EI1Required = property
 Units English = lb/in² | Standard = N/m².
 EI2Auto = property
 Units English = lb/in² | Standard = N/m².
 EI2Required = property
 Units English = lb/in² | Standard = N/m².
 Ex = property
 Units English = µin/in | Standard = µm/m.
 FatigueKTSkin = property
 FatigueKTStiff = property
 GJAuto = property
 Units English = lb/in² | Standard = N/m².
 GJRequired = property
 Units English = lb/in² | Standard = N/m².
 Id = property
 Unlike most entities with IDs, the ID of a Zone can be manually set with the RenumberZone(id) method.
 IsBeamColumn = property
 IsZeroOutFeaMoments = property
 IsZeroOutFeaTransverseShears = property
 MechanicalLimit = property
 MechanicalUltimate = property
 NonOptimumFactor = property
 SuperimposeBoundaryCondition = property
 SuperimposePanel = property
 ThermalHelp = property
 ThermalHurt = property
 Weight = property
 XSpan = property
 Units English = in | Standard = mm.
Properties inherited from hyperx.api.EntityWithAssignableProperties
 AssignedAnalysisProperty = property
 Get the analysis property assigned to this Entity.
 AssignedDesignProperty = property
 Get the design property assigned to this Entity.
 AssignedLoadProperty = property
 Get the load property assigned to this Entity.
Properties inherited from hyperx.api.IdNameEntity
 Name = property

Additional Inherited Members

Protected Attributes inherited from hyperx.api.IdEntity
 _Entity = idEntity
Static Protected Attributes inherited from hyperx.api.ZoneBase
 _Centroid

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.PanelSegment.__init__ ( self,
_api.PanelSegment panelSegment )

Member Function Documentation

◆ GetElements()

ElementCol hyperx.api.PanelSegment.GetElements ( self,
types.DiscreteDefinitionType discreteDefinitionType )

◆ SetObjectElements()

None hyperx.api.PanelSegment.SetObjectElements ( self,
types.DiscreteDefinitionType discreteDefinitionType,
tuple[int] elementIds )

Property Documentation

◆ DiscreteTechnique

hyperx.api.PanelSegment.DiscreteTechnique = property
static

◆ ElementsByObjectOrSkin

hyperx.api.PanelSegment.ElementsByObjectOrSkin = property
static

Return elements in the object / skin.

◆ LeftSkinZoneId

hyperx.api.PanelSegment.LeftSkinZoneId = property
static

◆ Objects

hyperx.api.PanelSegment.Objects = property
static

◆ RightSkinZoneId

hyperx.api.PanelSegment.RightSkinZoneId = property
static

◆ Skins

hyperx.api.PanelSegment.Skins = property
static

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