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

Inheritance diagram for hyperx.api.ZoneBase:

Public Member Functions
	__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).
None	IncludeAllDesignLoads (self)
	Convenience method for including all design loads in analysis, in the event any have been previously excluded via design load overrides.
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)

Static Protected Attributes
	_Centroid

Properties
	AddedWeight = property
	Beam English = lb/ft \| Standard = kg/m.
	BucklingImperfection = property
	Centroid = property
	DesignLoadOverrides = property
	Design load overrides keyed by hyperx.api.DesignLoad name.
	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.
	IncludedDesignLoads = 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
	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

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 )

Obselete.

Use hyperx.api.ZoneJointEntity.GetControllingResultsPerCriterion instead.

Reimplemented from hyperx.api.ZoneJointEntity.

◆ GetConceptName()

str hyperx.api.ZoneBase.GetConceptName ( self )

◆ GetControllingResult()

AnalysisResult hyperx.api.ZoneBase.GetControllingResult ( self )

Reimplemented from hyperx.api.ZoneJointEntity.

◆ GetControllingResultsPerCriterion()

AnalysisResultCol hyperx.api.ZoneBase.GetControllingResultsPerCriterion ( 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 )

◆ GetResults()

AnalysisResultCol hyperx.api.ZoneBase.GetResults ( self )

Get all analysis results for this zone.

Analysis details must be available to get results. If analysis details are unavailable, use hyperx.api.ZoneBase.GetControllingResultsPerCriterion or rerun analysis to populate them.

◆ GetZoneDesignResults()

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

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

◆ IncludeAllDesignLoads()

None hyperx.api.ZoneBase.IncludeAllDesignLoads ( self )

Convenience method for including all design loads in analysis, in the event any have been previously excluded via design load overrides.

◆ RenumberZone()

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

Attempt to update a zone's ID.

Member Data Documentation

◆ _Centroid

hyperx.api.ZoneBase._Centroid

staticprotected

Property Documentation

◆ AddedWeight

hyperx.api.ZoneBase.AddedWeight = property

static

Beam English = lb/ft | Standard = kg/m.

Panel English = lb/ft² | Standard = kg/m².

◆ BucklingImperfection

hyperx.api.ZoneBase.BucklingImperfection = property

static

◆ Centroid

hyperx.api.ZoneBase.Centroid = property

static

◆ DesignLoadOverrides

hyperx.api.ZoneBase.DesignLoadOverrides = property

static

Design load overrides keyed by hyperx.api.DesignLoad name.

◆ Dmid

hyperx.api.ZoneBase.Dmid = property

static

Units English = in | Standard = mm.

◆ EAAuto

hyperx.api.ZoneBase.EAAuto = property

static

Units English = lb | Standard = N.

◆ EARequired

hyperx.api.ZoneBase.EARequired = property

static

Units English = lb | Standard = N.

◆ EI1Auto

hyperx.api.ZoneBase.EI1Auto = property

static

Units English = lb/in² | Standard = N/m².

◆ EI1Required

hyperx.api.ZoneBase.EI1Required = property

static

Units English = lb/in² | Standard = N/m².

◆ EI2Auto

hyperx.api.ZoneBase.EI2Auto = property

static

Units English = lb/in² | Standard = N/m².

◆ EI2Required

hyperx.api.ZoneBase.EI2Required = property

static

Units English = lb/in² | Standard = N/m².

◆ Ex

hyperx.api.ZoneBase.Ex = property

static

Units English = µin/in | Standard = µm/m.

◆ FatigueKTSkin

hyperx.api.ZoneBase.FatigueKTSkin = property

static

◆ FatigueKTStiff

hyperx.api.ZoneBase.FatigueKTStiff = property

static

◆ GJAuto

hyperx.api.ZoneBase.GJAuto = property

static

Units English = lb/in² | Standard = N/m².

◆ GJRequired

hyperx.api.ZoneBase.GJRequired = property

static

Units English = lb/in² | Standard = N/m².

◆ Id

hyperx.api.ZoneBase.Id = property

static

Unlike most entities with IDs, the ID of a Zone can be manually set with the RenumberZone(id) method.

◆ IncludedDesignLoads

hyperx.api.ZoneBase.IncludedDesignLoads = 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

Units English = in | Standard = mm.

The documentation for this class was generated from the following file:

C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py

Public Member Functions

Static Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ GetAllResults()

◆ GetConceptName()

◆ GetControllingResult()

◆ GetControllingResultsPerCriterion()

◆ GetMinimumMargin()

◆ GetObjectName()

◆ GetResults()

◆ GetZoneDesignResults()

◆ IncludeAllDesignLoads()

◆ RenumberZone()

Member Data Documentation

◆ _Centroid

Property Documentation

◆ AddedWeight

◆ BucklingImperfection

◆ Centroid

◆ DesignLoadOverrides

◆ Dmid

◆ EAAuto

◆ EARequired

◆ EI1Auto

◆ EI1Required

◆ EI2Auto

◆ EI2Required

◆ Ex

◆ FatigueKTSkin

◆ FatigueKTStiff

◆ GJAuto

◆ GJRequired

◆ Id

◆ IncludedDesignLoads

◆ IsBeamColumn

◆ IsZeroOutFeaMoments

◆ IsZeroOutFeaTransverseShears

◆ MechanicalLimit

◆ MechanicalUltimate

◆ NonOptimumFactor

◆ SuperimposeBoundaryCondition

◆ SuperimposePanel

◆ ThermalHelp

◆ ThermalHurt

◆ Weight

◆ XSpan

◆ init()