HyperX.Scripting.Zone Class Reference

Abstract for regular Zones (not Panel Segments). More...

Inheritance diagram for HyperX.Scripting.Zone:

Public Member Functions
void	AddElements (IEnumerable< int > elementIds)
Public Member Functions inherited from HyperX.Scripting.ZoneBase
override AnalysisResultCol< AnalysisResult >	GetAllResults ()
string	GetConceptName ()
override AnalysisResult	GetControllingResult ()
override AnalysisResultCol< AnalysisResult >	GetControllingResultsPerCriterion ()
override Margin	GetMinimumMargin ()
string	GetObjectName (FamilyObjectUID objectId)
AnalysisResultCol< AnalysisResult >	GetResults ()
	Get all analysis results for this zone.
ZoneDesignResultCol	GetZoneDesignResults (int solutionId=1)
	Returns a collection of Zone Design Results for a Solution Id (default 1).
void	IncludeAllDesignLoads ()
	Convenience method for including all design loads in analysis, in the event any have been previously excluded via design load overrides.
ZoneIdUpdateStatus	RenumberZone (int newId)
	Attempt to update a zone's ID.
Public Member Functions inherited from HyperX.Scripting.ZoneJointEntity
AnalysisResultCol< AnalysisResult >	GetAllResults ()
	Obselete. Use GetControllingResultsPerCriterion instead.
AnalysisResult	GetControllingResult ()
AnalysisResultCol< AnalysisResult >	GetControllingResultsPerCriterion ()
Margin	GetMinimumMargin ()
Public Member Functions inherited from HyperX.Scripting.EntityWithAssignableProperties
PropertyAssignmentStatus	AssignAnalysisProperty (int id)
PropertyAssignmentStatus	AssignDesignProperty (int id)
PropertyAssignmentStatus	AssignLoadProperty (int id)
PropertyAssignmentStatus	AssignProperty (AssignableProperty property)
	Assign a Property to this entity.
Public Member Functions inherited from HyperX.Scripting.IdNameEntityRenameable
void	Rename (string name)

Properties
ElementCol	Elements [get]
Properties inherited from HyperX.Scripting.ZoneBase
HS.Model.Zone	_thisZone [get]
double	AddedWeight [get, set]
	Beam Units: English = lb/ft | Standard = kg/m. Panel Units: English = lb/ft² | Standard = kg/m².
double	BucklingImperfection [get, set]
Centroid	Centroid [get]
IReadOnlyDictionary< string, DesignLoadOverride >	DesignLoadOverrides [get]
	Design load overrides keyed by DesignLoad name.
double?	Dmid [get, set]
	Units: English = in | Standard = mm.
double?	EAAuto [get]
	Units: English = lb | Standard = N.
double?	EARequired [get, set]
	Units: English = lb | Standard = N.
double?	EI1Auto [get]
	Units: English = lb/in² | Standard = N/m².
double?	EI1Required [get, set]
	Units: English = lb/in² | Standard = N/m².
double?	EI2Auto [get]
	Units: English = lb/in² | Standard = N/m².
double?	EI2Required [get, set]
	Units: English = lb/in² | Standard = N/m².
double?	Ex [get, set]
	Units: English = µin/in | Standard = µm/m.
double	FatigueKTSkin [get, set]
double	FatigueKTStiff [get, set]
double?	GJAuto [get]
	Units: English = lb/in² | Standard = N/m².
double?	GJRequired [get, set]
	Units: English = lb/in² | Standard = N/m².
new int	Id [get]
	Unlike most entities with IDs, the ID of a Zone can be manually set with the RenumberZone(id) method.
IEnumerable< string >	IncludedDesignLoads [get, set]
bool	IsBeam [get]
bool	IsBeamColumn [get, set]
bool	IsZeroOutCurvature [get, set]
bool	IsZeroOutFeaMoments [get, set]
	Use IsZeroOutCurvature instead.
bool	IsZeroOutFeaTransverseShears [get, set]
double	MechanicalLimit [get, set]
double	MechanicalUltimate [get, set]
double	NonOptimumFactor [get, set]
int	SuperimposeBoundaryCondition [get, set]
bool	SuperimposePanel [get, set]
double	ThermalHelp [get, set]
double	ThermalHurt [get, set]
double?	Weight [get]
double	XSpan [get, set]
	Units: English = in | Standard = mm.
Properties inherited from HyperX.Scripting.EntityWithAssignableProperties
AnalysisProperty	AssignedAnalysisProperty [get]
	Get the analysis property assigned to this Entity. Returns null if none is assigned.
DesignProperty	AssignedDesignProperty [get]
	Get the design property assigned to this Entity. Returns null if none is assigned.
LoadProperty	AssignedLoadProperty [get]
	Get the load property assigned to this Entity. Returns null if none is assigned.
Properties inherited from HyperX.Scripting.IdNameEntity
string	Name [get, protected set]
Properties inherited from HyperX.Scripting.IdEntity
int	Id [get]

Additional Inherited Members
Protected Member Functions inherited from HyperX.Scripting.ZoneBase
override PropertyAssignmentStatus	AssignAnalysisPropertyToEntity (int id)
override PropertyAssignmentStatus	AssignDesignPropertyToEntity (Design design)
override PropertyAssignmentStatus	AssignLoadPropertyToEntity (int id)
override void	UpdateNameInDatabase (string name)
void	UpdateZone (bool mechanicalChanged=false)
override bool	ValidateName (string name)
	ZoneBase (Application application, int id, string name)
	Zones should only be created using the helper method.
Protected Member Functions inherited from HyperX.Scripting.ZoneJointEntity
Dictionary< int, AnalysisDefinition >	GetAnalyses ()
Dictionary< Guid, AnalysisDefinition >	GetAnalysesByGuid ()
Protected Member Functions inherited from HyperX.Scripting.EntityWithAssignableProperties
PropertyAssignmentStatus	AssignAnalysisPropertyToEntity (int id)
PropertyAssignmentStatus	AssignDesignPropertyToEntity (HS.Types.Design design)
PropertyAssignmentStatus	AssignLoadPropertyToEntity (int id)
Protected Member Functions inherited from HyperX.Scripting.IdNameEntityRenameable
void	UpdateNameInDatabase (string name)
	Rename this entity in the database.
bool	ValidateName (string name)
	Return true if this name is valid to use, false otherwise.
Protected Attributes inherited from HyperX.Scripting.ZoneBase
HS.Model.Zone	_modelRepoZone
Protected Attributes inherited from HyperX.Scripting.EntityWithAssignableProperties
readonly Application	_application

Detailed Description

Abstract for regular Zones (not Panel Segments).

Member Function Documentation

AddElements()

void HyperX.Scripting.Zone.AddElements

(

IEnumerable< int >

elementIds

)

Property Documentation

Elements

ElementCol HyperX.Scripting.Zone.Elements

get

---

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

• Zone/Zone.cs