HyperX.Scripting.Api
The HyperX C# Scripting Application Programming Interface
Loading...
Searching...
No Matches
HyperX.Scripting.Panel Class Referencesealed
Inheritance diagram for HyperX.Scripting.Panel:
HyperX.Scripting.Zone HyperX.Scripting.ZoneBase HyperX.Scripting.ZoneJointEntity HyperX.Scripting.IBulkUpdatableEntity HyperX.Scripting.EntityWithAssignableProperties HyperX.Scripting.IdNameEntityRenameable HyperX.Scripting.IdNameEntity HyperX.Scripting.IdEntity

Properties

double? A11Auto [get]
 Units: English = lb/in | N/mm.
double? A11Required [get, set]
 Units: English = lb/in | N/mm.
double? A22Auto [get]
 Units: English = lb/in | N/mm.
double? A22Required [get, set]
 Units: English = lb/in | N/mm.
double? A33Auto [get]
 Units: English = lb/in | N/mm.
double? A33Required [get, set]
 Units: English = lb/in | N/mm.
double AddedOffset [get, set]
 Units: English = in | Standard = mm.
double Area [get]
ZoneBucklingMode BucklingMode [get, set]
double? D11Auto [get]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D11AutoReduced [get]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D11ReducedRequired [get, set]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D11Required [get, set]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D22Auto [get]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D22AutoReduced [get]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D22ReducedRequired [get, set]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D22Required [get, set]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D33Auto [get]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D33AutoReduced [get]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D33ReducedRequired [get, set]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? D33Required [get, set]
 Units: English = lb*in²/in | Standard = N*mm²/mm.
double? Ey [get, set]
 Units: English = µin/in | Standard = µm/m.
double HoneycombCoreAngle [get, set]
 Units: English = degrees | Standard = degrees.
bool IsCurved [get, set]
bool IsFullCylinder [get, set]
double? Kx [get, set]
 Units: English = 1/in | Standard = 1/mm.
double? Ky [get, set]
 Units: English = 1/in | Standard = 1/mm.
bool PerformLocalPostbuckling [get, set]
double Radius [get, set]
 Units: English = in | Standard = mm.
ReferencePlanePanel ReferencePlane [get, set]
bool SuperImposeLocalPressure [get, set]
double YSpan [get, set]
 Units: English = in | Standard = mm.
Properties inherited from HyperX.Scripting.Zone
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

Public Member Functions inherited from HyperX.Scripting.Zone
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)
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

Property Documentation

◆ A11Auto

double? HyperX.Scripting.Panel.A11Auto
get

Units: English = lb/in | N/mm.

◆ A11Required

double? HyperX.Scripting.Panel.A11Required
getset

Units: English = lb/in | N/mm.

◆ A22Auto

double? HyperX.Scripting.Panel.A22Auto
get

Units: English = lb/in | N/mm.

◆ A22Required

double? HyperX.Scripting.Panel.A22Required
getset

Units: English = lb/in | N/mm.

◆ A33Auto

double? HyperX.Scripting.Panel.A33Auto
get

Units: English = lb/in | N/mm.

◆ A33Required

double? HyperX.Scripting.Panel.A33Required
getset

Units: English = lb/in | N/mm.

◆ AddedOffset

double HyperX.Scripting.Panel.AddedOffset
getset

Units: English = in | Standard = mm.

◆ Area

double HyperX.Scripting.Panel.Area
get

◆ BucklingMode

ZoneBucklingMode HyperX.Scripting.Panel.BucklingMode
getset

◆ D11Auto

double? HyperX.Scripting.Panel.D11Auto
get

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D11AutoReduced

double? HyperX.Scripting.Panel.D11AutoReduced
get

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D11ReducedRequired

double? HyperX.Scripting.Panel.D11ReducedRequired
getset

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D11Required

double? HyperX.Scripting.Panel.D11Required
getset

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D22Auto

double? HyperX.Scripting.Panel.D22Auto
get

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D22AutoReduced

double? HyperX.Scripting.Panel.D22AutoReduced
get

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D22ReducedRequired

double? HyperX.Scripting.Panel.D22ReducedRequired
getset

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D22Required

double? HyperX.Scripting.Panel.D22Required
getset

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D33Auto

double? HyperX.Scripting.Panel.D33Auto
get

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D33AutoReduced

double? HyperX.Scripting.Panel.D33AutoReduced
get

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D33ReducedRequired

double? HyperX.Scripting.Panel.D33ReducedRequired
getset

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ D33Required

double? HyperX.Scripting.Panel.D33Required
getset

Units: English = lb*in²/in | Standard = N*mm²/mm.

◆ Ey

double? HyperX.Scripting.Panel.Ey
getset

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

◆ HoneycombCoreAngle

double HyperX.Scripting.Panel.HoneycombCoreAngle
getset

Units: English = degrees | Standard = degrees.

◆ IsCurved

bool HyperX.Scripting.Panel.IsCurved
getset

◆ IsFullCylinder

bool HyperX.Scripting.Panel.IsFullCylinder
getset

◆ Kx

double? HyperX.Scripting.Panel.Kx
getset

Units: English = 1/in | Standard = 1/mm.

◆ Ky

double? HyperX.Scripting.Panel.Ky
getset

Units: English = 1/in | Standard = 1/mm.

◆ PerformLocalPostbuckling

bool HyperX.Scripting.Panel.PerformLocalPostbuckling
getset

◆ Radius

double HyperX.Scripting.Panel.Radius
getset

Units: English = in | Standard = mm.

◆ ReferencePlane

ReferencePlanePanel HyperX.Scripting.Panel.ReferencePlane
getset

◆ SuperImposeLocalPressure

bool HyperX.Scripting.Panel.SuperImposeLocalPressure
getset

◆ YSpan

double HyperX.Scripting.Panel.YSpan
getset

Units: English = in | Standard = mm.

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