HyperX.Scripting.Python.Api
Version 2026.1.13
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level
1
2
3
4
5
6
7
8
9
]
C
ABC
C
hyperx.api.AnalysisResult
Contains result information for an analysis
C
hyperx.api.JointAnalysisResult
C
hyperx.api.ZoneAnalysisResult
C
hyperx.api.ZoneAnalysisConceptResult
C
hyperx.api.ZoneAnalysisObjectResult
C
hyperx.api.ZoneAnalysisSolverResult
C
hyperx.api.BulkUpdaterBase
C
hyperx.api.DesignLoadBulkUpdater
C
hyperx.api.LoadPropertyUserRowBulkUpdater
C
hyperx.api.LoadPropertyUserFeaBeamRowBulkUpdater
C
hyperx.api.LoadPropertyUserFeaJointRowBulkUpdater
C
hyperx.api.LoadPropertyUserFeaPanelRowBulkUpdater
C
hyperx.api.LoadPropertyUserGeneralBeamRowBulkUpdater
C
hyperx.api.LoadPropertyUserGeneralPanelRowBulkUpdater
C
hyperx.api.PlateElementBulkUpdater
C
hyperx.api.ZoneBaseBulkUpdater
C
hyperx.api.BeamBulkUpdater
C
hyperx.api.PanelBulkUpdater
C
hyperx.api.PanelSegmentBulkUpdater
C
hyperx.api.ZoneBulkUpdater
C
hyperx.api.Environment
Represents HyperX's execution environment (where HyperX is installed)
C
hyperx.api.HelperFunctions
C
hyperx.api.IdEntity
Represents an entity with an ID
C
hyperx.api.DesignVariable
C
hyperx.api.Element
C
hyperx.api.PlateElement
C
hyperx.api.FabricationCriterionRatio
C
hyperx.api.IdNameEntity
Represents an entity with an ID and Name
C
hyperx.api.AnalysisDefinition
C
hyperx.api.AssignableProperty
C
hyperx.api.AssignablePropertyWithFamilyCategory
C
hyperx.api.AnalysisProperty
C
hyperx.api.DesignProperty
C
hyperx.api.JointDesignProperty
C
hyperx.api.ZoneDesignProperty
C
hyperx.api.LoadProperty
C
hyperx.api.LoadPropertyFea
C
hyperx.api.LoadPropertyAverage
C
hyperx.api.LoadPropertyElementBased
C
hyperx.api.LoadPropertyNeighborAverage
C
hyperx.api.LoadPropertyPeakLoad
C
hyperx.api.LoadPropertyStatistical
C
hyperx.api.LoadPropertyUserFeaBeam
C
hyperx.api.LoadPropertyUserFeaJoint
C
hyperx.api.LoadPropertyUserFeaPanel
C
hyperx.api.LoadPropertyUserGeneralBeam
C
hyperx.api.LoadPropertyUserGeneralBolted
C
hyperx.api.LoadPropertyUserGeneralBonded
C
hyperx.api.LoadPropertyUserGeneralPanel
C
hyperx.api.DesignLoad
C
hyperx.api.DesignLoadOverride
C
hyperx.api.DesignLoadSubcase
C
hyperx.api.DesignLoadSubcaseMultiplier
C
hyperx.api.DesignLoadSubcaseTemperature
C
hyperx.api.DesignLoadTemperatureProfile
C
hyperx.api.ElementSet
A set of elements defined in the input file
C
hyperx.api.FailureCriterion
C
hyperx.api.FailureModeCategory
C
hyperx.api.FailureObjectGroup
C
hyperx.api.FailureSetting
Setting for a Failure Mode or a Failure Criteria
C
hyperx.api.FailureCriterionSetting
Setting for a Failure Criteria
C
hyperx.api.FailureModeSetting
Setting for a Failure Mode
C
hyperx.api.FemProperty
A property description
C
hyperx.api.Folder
C
hyperx.api.IdNameEntityRenameable
C
hyperx.api.AutomatedConstraint
C
hyperx.api.ModalAutomatedConstraint
C
hyperx.api.BucklingAutomatedConstraint
C
hyperx.api.FrequencyAutomatedConstraint
C
hyperx.api.StaticAutomatedConstraint
C
hyperx.api.DisplacementAutomatedConstraint
C
hyperx.api.RotationAutomatedConstraint
C
hyperx.api.DiscreteField
Represents a table of discrete field data
C
hyperx.api.EntityWithAssignableProperties
C
hyperx.api.ZoneJointEntity
Abstract base for a
Zone
or
Joint
C
hyperx.api.Joint
C
hyperx.api.ZoneBase
Abstract for regular Zones and
Panel
Segments
C
hyperx.api.PanelSegment
C
hyperx.api.Zone
Abstract for regular Zones (not
Panel
Segments)
C
hyperx.api.Beam
C
hyperx.api.Panel
C
hyperx.api.FailureMode
C
hyperx.api.ManualConstraint
C
hyperx.api.ManualConstraintWithDesignLoad
C
hyperx.api.BucklingManualConstraint
C
hyperx.api.DisplacementManualConstraint
C
hyperx.api.FrequencyManualConstraint
C
hyperx.api.StaticMomentManualConstraint
C
hyperx.api.ProjectInfo
C
hyperx.api.ZoneJointContainer
Represents an entity that contains a collection of Zones and Joints
C
hyperx.api.Set
C
hyperx.api.Structure
C
hyperx.api.LaminateFamily
C
hyperx.api.LoadPropertyUserGeneralDoubleRow
C
hyperx.api.LoadPropertyUserGeneralBeamDoubleRow
C
hyperx.api.LoadPropertyUserGeneralPanelDoubleRow
C
hyperx.api.LoadPropertyUserRow
C
hyperx.api.LoadPropertyUserBeamRow
C
hyperx.api.LoadPropertyUserFeaBeamRow
C
hyperx.api.LoadPropertyUserGeneralBeamRow
C
hyperx.api.LoadPropertyUserPanelJointRow
C
hyperx.api.LoadPropertyUserFeaJointRow
C
hyperx.api.LoadPropertyUserFeaPanelRow
C
hyperx.api.LoadPropertyUserGeneralPanelRow
C
hyperx.api.PluginPackage
C
hyperx.api.Ply
C
hyperx.api.RunSet
C
hyperx.api.SectionCut
C
hyperx.api.ToolingConstraint
Tooling constraints are a feature of Design Properties for Zones
C
hyperx.api.JointDesignResult
C
hyperx.api.JointRangeDesignResult
C
hyperx.api.JointSelectionDesignResult
C
hyperx.api.JointFastenerDesignResult
C
hyperx.api.JointMaterialDesignResult
C
hyperx.api.JointRivetDesignResult
C
hyperx.api.LoadPropertyJoint
C
hyperx.api.LoadPropertyUserGeneralBoltedRow
C
hyperx.api.LoadPropertyUserGeneralBondedRow
C
hyperx.api.Node
C
hyperx.api.Rundeck
C
hyperx.api.SizingMaterial
C
hyperx.api.ZoneDesignResult
C
hyperx.api.ZoneOverride
C
hyperx.api.IdEntityCol
C
hyperx.api.DesignVariableCol
C
hyperx.api.ElementCol
C
hyperx.api.ElementSetCol
C
hyperx.api.FabricationCriterionRatioCol
C
hyperx.api.FemPropertyCol
C
hyperx.api.IdNameEntityCol
C
hyperx.api.AnalysisPropertyCol
C
hyperx.api.AutomatedConstraintCol
C
hyperx.api.DesignLoadCol
C
hyperx.api.DesignLoadSubcaseCol
C
hyperx.api.DesignLoadSubcaseMultiplierCol
C
hyperx.api.DesignLoadTemperatureProfileCol
C
hyperx.api.DesignPropertyCol
C
hyperx.api.DiscreteFieldCol
C
hyperx.api.EntityWithAssignablePropertiesCol
C
hyperx.api.JointCol
C
hyperx.api.PanelSegmentCol
C
hyperx.api.ZoneCol
C
hyperx.api.FailureCriterionCol
C
hyperx.api.FailureModeCategoryCol
C
hyperx.api.FailureModeCol
C
hyperx.api.FailureObjectGroupCol
C
hyperx.api.FailureSettingCol
C
hyperx.api.FolderCol
C
hyperx.api.LaminateFamilyCol
C
hyperx.api.LoadPropertyCol
C
hyperx.api.LoadPropertyUserFeaRowCol
C
hyperx.api.LoadPropertyUserFeaBeamRowCol
C
hyperx.api.LoadPropertyUserFeaJointRowCol
C
hyperx.api.LoadPropertyUserFeaPanelRowCol
C
hyperx.api.LoadPropertyUserGeneralRowCol
C
hyperx.api.LoadPropertyUserGeneralBeamRowCol
C
hyperx.api.LoadPropertyUserGeneralPanelRowCol
C
hyperx.api.ManualConstraintCol
C
hyperx.api.PluginPackageCol
C
hyperx.api.PlyCol
C
hyperx.api.ProjectInfoCol
C
hyperx.api.SectionCutCol
C
hyperx.api.ToolingConstraintCol
C
hyperx.api.ZoneJointContainerCol
C
hyperx.api.SetCol
C
hyperx.api.StructureCol
C
hyperx.api.JointDesignResultCol
C
hyperx.api.LoadPropertyUserGeneralBoltedRowCol
C
hyperx.api.LoadPropertyUserGeneralBondedRowCol
C
hyperx.api.RundeckCol
C
hyperx.api.SizingMaterialCol
C
hyperx.api.ZoneDesignResultCol
C
hyperx.api.ZoneOverrideCol
C
hyperx.api.LaminateBase
C
hyperx.api.Laminate
Laminate
C
hyperx.api.StiffenerLaminate
Stiffener
Laminate
C
hyperx.api.LaminateLayerBase
C
hyperx.api.LaminateLayer
Layer in a non-stiffener laminate
C
hyperx.api.StiffenerLaminateLayer
Stiffener
Laminate
Layer
C
hyperx.api.OrthotropicCorrectionFactorBase
Orthotropic
material correction factor
C
hyperx.api.OrthotropicEquationCorrectionFactor
Represents an equation-based orthotropic material correction factor
C
hyperx.api.OrthotropicTabularCorrectionFactor
Tabular correction factor
C
hyperx.api.AnalysisDetail
C
hyperx.api.Application
C
hyperx.api.BackdoorSetting
C
hyperx.api.BeamLoads
C
hyperx.api.Centroid
C
hyperx.api.types.DesignLink
C
hyperx.api.DesignLoadDefinition
Contains user defined design load information used in
hyperx.api.DesignLoadCol.Create
(System.Collections.Generic.IEnumerable{
hyperx.api.DesignLoadDefinition
})
C
hyperx.api.types.DuplicatedValue
Allows for enums with duplicated backing values, because Python turns any entries with duplicate values into aliases for the first entry
C
Enum
C
hyperx.api.AnalysisResultToReturn
Used to specify which analysis result to return
C
hyperx.api.CollectionModificationStatus
Indicates whether a collection was manipulated successfully
C
hyperx.api.CreateDatabaseStatus
C
hyperx.api.DbForceUnit
C
hyperx.api.DbLengthUnit
C
hyperx.api.DbMassUnit
C
hyperx.api.DbTemperatureUnit
C
hyperx.api.MaterialCreationStatus
C
hyperx.api.ProjectCreationStatus
C
hyperx.api.ProjectDeletionStatus
C
hyperx.api.PropertyAssignmentStatus
C
hyperx.api.RundeckBulkUpdateStatus
C
hyperx.api.RundeckCreationStatus
C
hyperx.api.RundeckRemoveStatus
C
hyperx.api.RundeckUpdateStatus
C
hyperx.api.SetUnitsStatus
C
hyperx.api.UnitSystem
Unit system specified when starting a scripting
Application
C
hyperx.api.ZoneCreationStatus
C
hyperx.api.ZoneIdUpdateStatus
C
hyperx.api.types.AllowableMethodName
Method name for a laminate allowable
C
hyperx.api.types.AllowablePropertyName
Property name for a laminate allowable
C
hyperx.api.types.AnalysisId
C
hyperx.api.types.BackdoorFlagId
C
hyperx.api.types.BackdoorTypeId
C
hyperx.api.types.BeamPanelFamily
C
hyperx.api.types.BoundaryConditionType
C
hyperx.api.types.BundlePackageInclusionMode
C
hyperx.api.types.ConstraintType
C
hyperx.api.types.CorrectionCategory
Correction property category
C
hyperx.api.types.CorrectionFactorCategory
C
hyperx.api.types.CorrectionId
Correction ID for a correction factor
C
hyperx.api.types.CorrectionValueType
Defines the type of the independent values on a tabular correction factor row
C
hyperx.api.types.DegreeOfFreedom
C
hyperx.api.types.DeprecatedEnum
Based
https://stackoverflow.com/a/62309159
C
hyperx.api.types.CorrectionEquation
Equation for a correction factor
C
hyperx.api.types.CorrectionIndependentDefinition
Defines the type of Correction Factor
C
hyperx.api.types.CorrectionProperty
Property name for a correction factor
C
hyperx.api.types.EquationParameterId
Correction factor parameter names
C
hyperx.api.types.LoadPropertyType
C
hyperx.api.types.DesignLoadFilteringOptions
C
hyperx.api.types.DiscreteDefinitionType
C
hyperx.api.types.DiscreteFieldDataType
Defines the type of data stored in a Discrete Field
C
hyperx.api.types.DiscreteFieldPhysicalEntityType
Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc
C
hyperx.api.types.DiscreteTechnique
FEM Modeling technique for a
Zone
C
hyperx.api.types.DisplacementShapeType
C
hyperx.api.types.DoePlotMode
C
hyperx.api.types.DoePointType
C
hyperx.api.types.EndAbMomentMode
C
hyperx.api.types.EntityBuildingApproach
C
hyperx.api.types.FabricationRatio
C
hyperx.api.types.FamilyCategory
C
hyperx.api.types.FamilyConceptUID
C
hyperx.api.types.FamilyObjectUID
C
hyperx.api.types.FeaSolutionType
C
hyperx.api.types.FemMappingType
C
hyperx.api.types.FemType
C
hyperx.api.types.ForceTransformType
C
hyperx.api.types.HeightSizingVariable
C
hyperx.api.types.ImageType
C
hyperx.api.types.JointConceptId
C
hyperx.api.types.JointObject
Enum identifying the possible entities within a joint
C
hyperx.api.types.JointRangeId
C
hyperx.api.types.JointRangeMode
C
hyperx.api.types.JointSelectionId
C
hyperx.api.types.LaminateFamilySettingType
C
hyperx.api.types.LaminateFamilyType
C
hyperx.api.types.LicenseStatus
C
hyperx.api.types.LimitUltimate
Limit vs Ultimate loads
C
hyperx.api.types.LoadCaseType
C
hyperx.api.types.LoadPropertyAverageElementType
C
hyperx.api.types.LoadPropertyPeakElementScope
C
hyperx.api.types.LoadScenarioLimit
How the limit on load scenario result data should be interpreted
C
hyperx.api.types.LoadSetType
C
hyperx.api.types.LoadSubCaseFactor
C
hyperx.api.types.MarginCode
C
hyperx.api.types.MaterialMode
C
hyperx.api.types.MaterialType
Represents a material's type
C
hyperx.api.types.ModuleType
C
hyperx.api.types.ObjectGroup
C
hyperx.api.types.PlyDropPattern
C
hyperx.api.types.PlyStiffenerSubType
C
hyperx.api.types.ProjectModelFormat
C
hyperx.api.types.ReferencePlaneBeam
C
hyperx.api.types.ReferencePlanePanel
C
hyperx.api.types.RequestedAnalysisDetailData
C
hyperx.api.types.RequestedAnalysisResultData
C
hyperx.api.types.SectionCutPropertyLocation
Centroid
vs Origin
C
hyperx.api.types.SolverFileFormat
C
hyperx.api.types.StiffenerLaminateLayerLocation
C
hyperx.api.types.StiffenerProfile
C
hyperx.api.types.StiffnessCriteriaType
C
hyperx.api.types.StressReportFormat
C
hyperx.api.types.TemperatureChoiceType
C
hyperx.api.types.TernaryStatusCode
C
hyperx.api.types.ToolingSelectionType
Defines which selection a given tooling constraint is currently set to
C
hyperx.api.types.UserConstantDataType
C
hyperx.api.types.VariableInputMode
C
hyperx.api.types.VariableParameter
C
hyperx.api.types.ZoneBucklingMode
C
EnumMeta
C
hyperx.api.types.OnAccess
Runs a user-specified function whenever member is accessed
C
hyperx.api.types.DeprecatedEnum
Based
https://stackoverflow.com/a/62309159
C
hyperx.api.FemDataSet
C
hyperx.api.Foam
Foam
material
C
hyperx.api.FoamTemperature
Foam
material temperature dependent properties
C
Generic
C
hyperx.api.AnalysisDetailCol
C
hyperx.api.AnalysisResultCol
C
hyperx.api.EntityWithAssignablePropertiesCol
C
hyperx.api.FoamCol
C
hyperx.api.HoneycombCol
C
hyperx.api.IdEntityCol
C
hyperx.api.IdNameEntityCol
C
hyperx.api.IsotropicCol
C
hyperx.api.LaminateCol
C
hyperx.api.LoadPropertyUserFeaRowCol
C
hyperx.api.LoadPropertyUserGeneralRowCol
C
hyperx.api.OrthotropicCol
C
hyperx.api.PackageCol
C
hyperx.api.PackageFileSystemSourceCol
C
hyperx.api.PackageVersionCol
C
hyperx.api.ZoneJointContainerCol
C
hyperx.api.Honeycomb
Honeycomb
material
C
hyperx.api.HoneycombTemperature
Honeycomb
material temperature dependent properties
C
hyperx.api.HyperFea
C
hyperx.api.types.HyperFeaSolver
C
hyperx.api.HyperXpertPoint
C
hyperx.api.IBulkUpdatableEntity
C
hyperx.api.Isotropic
Isotropic
material
C
hyperx.api.IsotropicTemperature
Isotropic
material temperature dependent properties
C
hyperx.api.LaminatePlyData
Per ply data for
Laminate
materials
C
hyperx.api.types.LicenseStatusWrapper
C
hyperx.api.Margin
Represents a
Margin
result
C
metaclass
C
hyperx.api.types.DeprecatedEnum
Based
https://stackoverflow.com/a/62309159
C
hyperx.api.Orthotropic
Orthotropic
material
C
hyperx.api.OrthotropicAllowableCurvePoint
Represents a point on a laminate allowable curve
C
hyperx.api.OrthotropicCorrectionFactorPoint
Pointer to an Equation-based or Tabular Correction Factor
C
hyperx.api.OrthotropicCorrectionFactorValue
Orthotropic
material equation-based correction factor value
C
hyperx.api.OrthotropicEffectiveLaminate
C
hyperx.api.OrthotropicLaminateAllowable
Orthotropic
material laminate allowable properties
C
hyperx.api.OrthotropicTemperature
Orthotropic
material temperature dependent properties
C
hyperx.api.Package
C
hyperx.api.PackageDependency
C
hyperx.api.PackageFileSystemSource
Represents a package source that exists as a folder on a file system
C
hyperx.api.PackageManager
C
hyperx.api.PackageModule
C
hyperx.api.PackageVersion
C
hyperx.api.Project
Represents a HyperX project within a database
C
hyperx.api.RundeckPathPair
C
hyperx.api.RunSetSpecifier
Used to specify runsets as an input to some methods
C
hyperx.api.types.SimpleStatus
Lots of methods need to return a Success state and an associated Message
C
hyperx.api.types.TernaryStatus
C
hyperx.api.SolverSettings
C
hyperx.api.TabularCorrectionFactorIndependentValue
Contains an independent value for a tabular correction factor row
C
hyperx.api.TabularCorrectionFactorRow
Row data for a tabular correction factor
C
hyperx.api.Vector2d
Represents a readonly 2D vector
C
hyperx.api.Vector3d
Represents a readonly 3D vector
C
hyperx.api.ZoneDesignLoadKey
Compound key for use in
hyperx.api.DesignLoadCol.GetOverridesForZoneDesignLoadKeys
(System.Collections.Generic.HashSet{
hyperx.api.ZoneDesignLoadKey
})
C
hyperx.api.ZoneDesignLoadOverride
Generated by
1.16.1