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

Abstract for regular Zones and Panel Segments. More...

Inheritance diagram for hyperx.api.ZoneBase:
hyperx.api.ZoneJointEntity hyperx.api.EntityWithAssignableProperties hyperx.api.IdNameEntityRenameable hyperx.api.IdNameEntity hyperx.api.IdEntity hyperx.api.PanelSegment hyperx.api.Zone hyperx.api.Beam hyperx.api.Panel

Public Member Functions

 __init__ (self, _api.ZoneBase zoneBase)
AnalysisResultCol GetAllResults (self)
str GetConceptName (self)
AnalysisResult GetControllingResult (self)
Margin GetMinimumMargin (self)
str GetObjectName (self, types.FamilyObjectUID objectId)
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

 AddedWeight = property
 BucklingImperfection = property
 Centroid = property
 Dmid = property
 EAAuto = property
 EARequired = property
 EI1Auto = property
 EI1Required = property
 EI2Auto = property
 EI2Required = property
 Ex = property
 FatigueKTSkin = property
 FatigueKTStiff = property
 GJAuto = property
 GJRequired = property
 Id = property
 IsBeamColumn = property
 IsZeroOutFeaMoments = property
 IsZeroOutFeaTransverseShears = property
 MechanicalLimit = property
 MechanicalUltimate = property
 NonOptimumFactor = property
 SuperimposeBoundaryCondition = property
 SuperimposePanel = property
 ThermalHelp = property
 ThermalHurt = property
 Weight = property
 XSpan = property
Properties inherited from hyperx.api.EntityWithAssignableProperties
 AssignedAnalysisProperty = property
 AssignedDesignProperty = property
 AssignedLoadProperty = property
Properties inherited from hyperx.api.IdNameEntity
 Name = property

Additional Inherited Members

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

Detailed Description

Abstract for regular Zones and Panel Segments.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.ZoneBase.__init__ ( self,
_api.ZoneBase zoneBase )

Member Function Documentation

◆ GetAllResults()

AnalysisResultCol hyperx.api.ZoneBase.GetAllResults ( self)

Reimplemented from hyperx.api.ZoneJointEntity.

◆ GetConceptName()

str hyperx.api.ZoneBase.GetConceptName ( self)

◆ GetControllingResult()

AnalysisResult hyperx.api.ZoneBase.GetControllingResult ( self)

Reimplemented from hyperx.api.ZoneJointEntity.

◆ GetMinimumMargin()

Margin hyperx.api.ZoneBase.GetMinimumMargin ( self)

Reimplemented from hyperx.api.ZoneJointEntity.

◆ GetObjectName()

str hyperx.api.ZoneBase.GetObjectName ( self,
types.FamilyObjectUID objectId )

◆ GetZoneDesignResults()

ZoneDesignResultCol hyperx.api.ZoneBase.GetZoneDesignResults ( self,
int solutionId = 1 )

Returns a collection of Zone Design Results for a Solution Id (default 1).

◆ RenumberZone()

ZoneIdUpdateStatus hyperx.api.ZoneBase.RenumberZone ( self,
int newId )

Attempt to update a zone's ID.

Property Documentation

◆ AddedWeight

hyperx.api.ZoneBase.AddedWeight = property
static

◆ BucklingImperfection

hyperx.api.ZoneBase.BucklingImperfection = property
static

◆ Centroid

hyperx.api.ZoneBase.Centroid = property
static

◆ Dmid

hyperx.api.ZoneBase.Dmid = property
static

◆ EAAuto

hyperx.api.ZoneBase.EAAuto = property
static

◆ EARequired

hyperx.api.ZoneBase.EARequired = property
static

◆ EI1Auto

hyperx.api.ZoneBase.EI1Auto = property
static

◆ EI1Required

hyperx.api.ZoneBase.EI1Required = property
static

◆ EI2Auto

hyperx.api.ZoneBase.EI2Auto = property
static

◆ EI2Required

hyperx.api.ZoneBase.EI2Required = property
static

◆ Ex

hyperx.api.ZoneBase.Ex = property
static

◆ FatigueKTSkin

hyperx.api.ZoneBase.FatigueKTSkin = property
static

◆ FatigueKTStiff

hyperx.api.ZoneBase.FatigueKTStiff = property
static

◆ GJAuto

hyperx.api.ZoneBase.GJAuto = property
static

◆ GJRequired

hyperx.api.ZoneBase.GJRequired = property
static

◆ Id

hyperx.api.ZoneBase.Id = property
static

◆ IsBeamColumn

hyperx.api.ZoneBase.IsBeamColumn = property
static

◆ IsZeroOutFeaMoments

hyperx.api.ZoneBase.IsZeroOutFeaMoments = property
static

◆ IsZeroOutFeaTransverseShears

hyperx.api.ZoneBase.IsZeroOutFeaTransverseShears = property
static

◆ MechanicalLimit

hyperx.api.ZoneBase.MechanicalLimit = property
static

◆ MechanicalUltimate

hyperx.api.ZoneBase.MechanicalUltimate = property
static

◆ NonOptimumFactor

hyperx.api.ZoneBase.NonOptimumFactor = property
static

◆ SuperimposeBoundaryCondition

hyperx.api.ZoneBase.SuperimposeBoundaryCondition = property
static

◆ SuperimposePanel

hyperx.api.ZoneBase.SuperimposePanel = property
static

◆ ThermalHelp

hyperx.api.ZoneBase.ThermalHelp = property
static

◆ ThermalHurt

hyperx.api.ZoneBase.ThermalHurt = property
static

◆ Weight

hyperx.api.ZoneBase.Weight = property
static

◆ XSpan

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