Classes
class	AnalysisDefinition
class	AnalysisDetail
class	AnalysisDetailCol
class	AnalysisProperty
class	AnalysisPropertyCol
class	AnalysisResult
	Contains result information for an analysis. More...
class	AnalysisResultCol< T >
	Represents a collection of AnalysisResult entries. More...
class	Application
class	AssignableProperty
class	AssignablePropertyWithFamilyCategory
class	AutomatedConstraint
class	AutomatedConstraintCol
class	Beam
class	BeamBulkUpdater
class	BeamLoads
class	BucklingAutomatedConstraint
class	BucklingManualConstraint
class	BulkUpdaterBase< T >
class	Centroid
class	DesignLoad
class	DesignLoadCol
class	DesignLoadOverride
class	DesignLoadSubcase
class	DesignLoadSubcaseMultiplier
class	DesignLoadSubcaseMultiplierCol
class	DesignLoadSubcaseTemperature
class	DesignProperty
class	DesignPropertyCol
class	DesignVariable
	Holds design variable data. Min, max, steps, materials. More...
class	DesignVariableCol
class	DiscreteField
	Represents a table of discrete field data. More...
class	DiscreteFieldCol
class	DisplacementAutomatedConstraint
class	DisplacementManualConstraint
class	Element
class	ElementCol
class	ElementSet
	A set of elements defined in the input file. More...
class	ElementSetCol
class	EntityWithAssignableProperties
class	EntityWithAssignablePropertiesCol< T >
class	Environment
	Represents HyperX's execution environment (where HyperX is installed). More...
class	FabricationCriterionRatio
class	FabricationCriterionRatioCol
class	FailureCriterion
class	FailureCriterionCol
class	FailureCriterionSetting
	Setting for a Failure Criteria. More...
class	FailureMode
class	FailureModeCategory
class	FailureModeCategoryCol
class	FailureModeCol
class	FailureModeSetting
	Setting for a Failure Mode. More...
class	FailureObjectGroup
class	FailureObjectGroupCol
class	FailureSetting
	Setting for a Failure Mode or a Failure Criteria. More...
class	FailureSettingCol
class	FemDataSet
class	FemProperty
	A property description. More...
class	FemPropertyCol
class	Foam
	Foam material. More...
class	FoamCol
	Contains a set of all foam materials in a database. More...
class	FoamTemperature
	Foam material temperature dependent properties. More...
class	Folder< T >
class	FolderCol< T >
class	FrequencyAutomatedConstraint
class	FrequencyManualConstraint
class	HelperFunctions
class	Honeycomb
	Honeycomb material. More...
class	HoneycombCol
	Contains a set of all honeycomb materials in a database. More...
class	HoneycombTemperature
	Honeycomb material temperature dependent properties. More...
class	HyperFea
class	HyperXpertPoint
interface	IBulkUpdatableEntity
class	IdEntity
	Represents an entity with an ID. More...
class	IdEntityCol< T >
	Represents a collection of entities with IDs. More...
class	IdNameEntity
	Represents an entity with an ID and Name. More...
class	IdNameEntityCol< T >
	Represents a collection of entities with IDs and names. More...
class	IdNameEntityRenameable
class	Isotropic
	Isotropic material. More...
class	IsotropicCol
	Contains a set of all isotropic materials in a database. More...
class	IsotropicTemperature
	Isotropic material temperature dependent properties. More...
class	Joint
class	JointAnalysisResult
class	JointCol
class	JointDesignProperty
class	JointDesignResult
class	JointDesignResultCol
class	JointFastenerDesignResult
class	JointMaterialDesignResult
class	JointRangeDesignResult
class	JointRivetDesignResult
class	JointSelectionDesignResult
class	Laminate
	Laminate. More...
class	LaminateBase
class	LaminateCol
class	LaminateFamily
class	LaminateFamilyCol
class	LaminateLayer
	Layer in a non-stiffener laminate. More...
class	LaminateLayerBase
class	LaminatePlyData
	Per ply data for Laminate materials. More...
class	LoadProperty
class	LoadPropertyAverage
class	LoadPropertyCol
class	LoadPropertyElementBased
class	LoadPropertyFea
class	LoadPropertyJoint
class	LoadPropertyNeighborAverage
class	LoadPropertyPeakLoad
class	LoadPropertyStatistical
class	LoadPropertyUserBeamRow
class	LoadPropertyUserFeaBeam
class	LoadPropertyUserFeaBeamRow
class	LoadPropertyUserFeaBeamRowBulkUpdater
class	LoadPropertyUserFeaBeamRowCol
class	LoadPropertyUserFeaJoint
class	LoadPropertyUserFeaJointRow
class	LoadPropertyUserFeaJointRowBulkUpdater
class	LoadPropertyUserFeaJointRowCol
class	LoadPropertyUserFeaPanel
class	LoadPropertyUserFeaPanelRow
class	LoadPropertyUserFeaPanelRowBulkUpdater
class	LoadPropertyUserFeaPanelRowCol
class	LoadPropertyUserFeaRowCol< T >
class	LoadPropertyUserGeneralBeam
class	LoadPropertyUserGeneralBeamDoubleRow
class	LoadPropertyUserGeneralBeamRow
class	LoadPropertyUserGeneralBeamRowBulkUpdater
class	LoadPropertyUserGeneralBeamRowCol
class	LoadPropertyUserGeneralBolted
class	LoadPropertyUserGeneralBoltedRow
class	LoadPropertyUserGeneralBoltedRowCol
class	LoadPropertyUserGeneralBonded
class	LoadPropertyUserGeneralBondedRow
class	LoadPropertyUserGeneralBondedRowCol
class	LoadPropertyUserGeneralDoubleRow
class	LoadPropertyUserGeneralPanel
class	LoadPropertyUserGeneralPanelDoubleRow
class	LoadPropertyUserGeneralPanelRow
class	LoadPropertyUserGeneralPanelRowBulkUpdater
class	LoadPropertyUserGeneralPanelRowCol
class	LoadPropertyUserGeneralRowCol< T >
class	LoadPropertyUserPanelJointRow
class	LoadPropertyUserRow
class	LoadPropertyUserRowBulkUpdater< T >
class	ManualConstraint
class	ManualConstraintCol
class	ManualConstraintWithDesignLoad
class	Margin
	Represents a Margin result. More...
class	ModalAutomatedConstraint
class	Node
class	Orthotropic
	Orthotropic material. More...
class	OrthotropicAllowableCurvePoint
	Represents a point on a laminate allowable curve. More...
class	OrthotropicCol
	Contains a set of all orthotropic materials in a database. More...
class	OrthotropicCorrectionFactorBase
	Orthotropic material correction factor. More...
class	OrthotropicCorrectionFactorPoint
	Pointer to an Equation-based or Tabular Correction Factor. More...
class	OrthotropicCorrectionFactorValue
	Orthotropic material equation-based correction factor value. (NOT TABULAR). More...
class	OrthotropicEffectiveLaminate
	Orthotropic material effective laminate properties. Read-only from the API. Check if material is an effective laminate with orthotropic.IsEffectiveLaminate. More...
class	OrthotropicEquationCorrectionFactor
	Represents an equation-based orthotropic material correction factor. More...
class	OrthotropicLaminateAllowable
	Orthotropic material laminate allowable properties. More...
class	OrthotropicTabularCorrectionFactor
	Tabular correction factor. More...
class	OrthotropicTemperature
	Orthotropic material temperature dependent properties. More...
class	Panel
class	PanelBulkUpdater
class	PanelSegment
class	PanelSegmentBulkUpdater
class	PanelSegmentCol
class	PlateElement
class	PlateElementBulkUpdater
class	PluginPackage
class	PluginPackageCol
class	Ply
class	PlyCol
class	Project
	Represents a HyperX project within a database. More...
class	ProjectInfo
class	ProjectInfoCol
	Contains a set of all projects in a database. More...
class	RotationAutomatedConstraint
class	Rundeck
class	RundeckCol
class	RundeckPathPair
class	RunSet
class	RunSetSpecifier
	Used to specify runsets as an input to some methods. More...
class	SectionCut
class	SectionCutCol
class	Set
class	SetCol
class	SizingMaterial
class	SizingMaterialCol
class	StaticAutomatedConstraint
class	StaticMomentManualConstraint
class	StiffenerLaminate
	Stiffener Laminate. More...
class	StiffenerLaminateLayer
	Stiffener Laminate Layer. More...
class	Structure
class	StructureCol
class	TabularCorrectionFactorIndependentValue
	Contains an independent value for a tabular correction factor row. More...
class	TabularCorrectionFactorRow
	Row data for a tabular correction factor. More...
class	ToolingConstraint
	Tooling constraints are a feature of Design Properties for Zones. More...
class	ToolingConstraintCol
struct	Vector2d
	Represents a readonly 2D vector. More...
struct	Vector3d
	Represents a readonly 3D vector. More...
class	Zone
	Abstract for regular Zones (not Panel Segments). More...
class	ZoneAnalysisConceptResult
class	ZoneAnalysisObjectResult
class	ZoneAnalysisResult
class	ZoneAnalysisSolverResult
class	ZoneBase
	Abstract for regular Zones and Panel Segments. More...
class	ZoneBaseBulkUpdater< T >
class	ZoneBulkUpdater
class	ZoneCol
class	ZoneDesignProperty
class	ZoneDesignResult
class	ZoneDesignResultCol
class	ZoneJointContainer
	Represents an entity that contains a collection of Zones and Joints. More...
class	ZoneJointContainerCol< T >
class	ZoneJointEntity
	Abstract base for a Zone or Joint. More...
class	ZoneOverride
class	ZoneOverrideCol

Enumerations
enum	AnalysisResultToReturn { Limit = 1 , Ultimate = 2 , Minimum = 3 }
	Used to specify which analysis result to return. More...
enum	CollectionModificationStatus { Success = 1 , DuplicateIdFailure = 2 , EntityMissingAddFailure = 3 , EntityMissingRemovalFailure = 4 , FemConnectionFailure = 5 , RunSetUsageFailure = 6 , EntityRemovalDependencyFailure = 7 }
	Indicates whether a collection was manipulated successfully. More...
enum	CreateDatabaseStatus { Success = 1 , TemplateNotFound = 2 , ImproperExtension = 3 }
enum	DbForceUnit { Pounds = HsDb.Types.DbForceUnit.Pounds , Newtons = HsDb.Types.DbForceUnit.Newtons , Dekanewtons = HsDb.Types.DbForceUnit.Dekanewtons }
enum	DbLengthUnit { Inches = HsDb.Types.DbLengthUnit.Inches , Feet = HsDb.Types.DbLengthUnit.Feet , Meters = HsDb.Types.DbLengthUnit.Meters , Centimeters = HsDb.Types.DbLengthUnit.Centimeters , Millimeters = HsDb.Types.DbLengthUnit.Millimeters }
enum	DbMassUnit { Pounds = HsDb.Types.DbMassUnit.Pounds , Kilograms = HsDb.Types.DbMassUnit.Kilograms , Slinches = HsDb.Types.DbMassUnit.Slinches , Slugs = HsDb.Types.DbMassUnit.Slugs , Megagrams = HsDb.Types.DbMassUnit.Megagrams }
enum	DbTemperatureUnit { Fahrenheit = HsDb.Types.DbTemperatureUnit.Fahrenheit , Rankine = HsDb.Types.DbTemperatureUnit.Rankine , Celsius = HsDb.Types.DbTemperatureUnit.Celsius , Kelvin = HsDb.Types.DbTemperatureUnit.Kelvin }
enum	MaterialCreationStatus { Success = 1 , DuplicateNameFailure = 2 , DuplicateFemIdFailure = 3 , MissingMaterialToCopy = 4 }
	Indicates whether a material was created successfully. If not, this indicates why the material was not created. More...
enum	ProjectCreationStatus { Success = 1 , Failure = 2 , DuplicateNameFailure = 3 }
	Indicates whether a project was created successfully. If not, this indicates why the project was not created. More...
enum	ProjectDeletionStatus { Success = 1 , Failure = 2 , ProjectDoesNotExistFailure = 3 , ActiveProjectFailure = 4 }
	Indicates whether a project was deleted successfully. If not, this indicates why the project was not deleted. More...
enum	PropertyAssignmentStatus { Success = 1 , Failure = 2 , FailureCollectionAssignment = 3 , PropertyIsNull = 4 , PropertyNotFoundInDb = 5 , EmptyCollection = 6 , IncompatiblePropertyAssignment = 7 , EntityDoesNotExist = 8 , IncompatibleCategoryAssignment = 9 }
enum	RundeckBulkUpdateStatus { NoRundecksUpdated = 0 , Success = 1 , InputFilePathDoesNotExist = 2 , ResultFilePathDoesNotExist = 3 , InputFilePathAlreadyExists = 4 , ResultFilePathAlreadyExists = 5 , InvalidPathCount = 6 , RundeckBulkUpdateFailure = 7 , SuccessButIncompatibleFem = 8 }
enum	RundeckCreationStatus { Success = 1 , InputFilePathAlreadyExists = 2 , ResultFilePathAlreadyExists = 3 }
enum	RundeckRemoveStatus { Success = 1 , InvalidId = 2 , CannotRemoveLastRundeck = 3 , CannotDeletePrimaryRundeck = 4 , RundeckNotFound = 5 , RundeckRemoveFailure = 6 , SuccessButIncompatibleFem = 7 }
enum	RundeckUpdateStatus { Success = 1 , InvalidId = 2 , IdDoesNotExist = 3 , RundeckAlreadyPrimary = 4 , InputPathInUse = 5 , ResultPathInUse = 6 , RundeckCommitFailure = 7 , InputPathDoesNotExist = 8 , ResultPathDoesNotExist = 9 , SuccessButIncompatibleFem = 10 }
enum	SetUnitsStatus { Success = 1 , Error = 2 , MixedUnitSystemError = 3 }
enum	UnitSystem { English = 1 , SI = 2 }
	Unit system specified when starting a scripting Application. More...
enum	ZoneCreationStatus { Success = 1 , DuplicateNameFailure = 2 , InvalidFamilyCategory = 3 }
	Indicates whether a zone was created successfully. If not, this indicates why the zone was not created. More...
enum	ZoneIdUpdateStatus { Success = 1 , DuplicateIdFailure = 2 , IdOutOfRangeError = 3 }

Enumeration Type Documentation

◆ AnalysisResultToReturn

enum HyperX.Scripting.AnalysisResultToReturn

Used to specify which analysis result to return.

Enumerator
Limit	1
Ultimate	2
Minimum	3

◆ CollectionModificationStatus

enum HyperX.Scripting.CollectionModificationStatus

Indicates whether a collection was manipulated successfully.

Enumerator
Success	1
DuplicateIdFailure	2	An entity with this ID already exists in this collection.
EntityMissingAddFailure	3	An entity with the specified ID does not exist, and therefore cannot be added to this collection.
EntityMissingRemovalFailure	4	An entity with the specified ID does not exist, and therefore cannot be removed from this collection.
FemConnectionFailure	5	Could not succesfully connect to the appropriate FEM.
RunSetUsageFailure	6	Run sets exist in the project, meaning that zones and structures cannot be deleted.
EntityRemovalDependencyFailure	7	Could not delete this entry because another entity in the database depends upon it.

◆ CreateDatabaseStatus

enum HyperX.Scripting.CreateDatabaseStatus

Enumerator
Success	1
TemplateNotFound	2
ImproperExtension	3	Make sure that your new database ends with a ".hdb3 extension".

◆ DbForceUnit

enum HyperX.Scripting.DbForceUnit

Enumerator
Pounds	HsDb.Types.DbForceUnit.Pounds
Newtons	HsDb.Types.DbForceUnit.Newtons
Dekanewtons	HsDb.Types.DbForceUnit.Dekanewtons

◆ DbLengthUnit

enum HyperX.Scripting.DbLengthUnit

Enumerator
Inches	HsDb.Types.DbLengthUnit.Inches
Feet	HsDb.Types.DbLengthUnit.Feet
Meters	HsDb.Types.DbLengthUnit.Meters
Centimeters	HsDb.Types.DbLengthUnit.Centimeters
Millimeters	HsDb.Types.DbLengthUnit.Millimeters

◆ DbMassUnit

enum HyperX.Scripting.DbMassUnit

Enumerator
Pounds	HsDb.Types.DbMassUnit.Pounds
Kilograms	HsDb.Types.DbMassUnit.Kilograms
Slinches	HsDb.Types.DbMassUnit.Slinches
Slugs	HsDb.Types.DbMassUnit.Slugs
Megagrams	HsDb.Types.DbMassUnit.Megagrams

◆ DbTemperatureUnit

enum HyperX.Scripting.DbTemperatureUnit

Enumerator
Fahrenheit	HsDb.Types.DbTemperatureUnit.Fahrenheit
Rankine	HsDb.Types.DbTemperatureUnit.Rankine
Celsius	HsDb.Types.DbTemperatureUnit.Celsius
Kelvin	HsDb.Types.DbTemperatureUnit.Kelvin

◆ MaterialCreationStatus

enum HyperX.Scripting.MaterialCreationStatus

Indicates whether a material was created successfully. If not, this indicates why the material was not created.

Enumerator
Success	1
DuplicateNameFailure	2
DuplicateFemIdFailure	3
MissingMaterialToCopy	4	Only valid for Copy operations, not for Get operations.

◆ ProjectCreationStatus

enum HyperX.Scripting.ProjectCreationStatus

Indicates whether a project was created successfully. If not, this indicates why the project was not created.

Enumerator
Success	1
Failure	2	The operation failed for an undefined reason.
DuplicateNameFailure	3	Cannot create project with this name, as it already exists in this database.

◆ ProjectDeletionStatus

enum HyperX.Scripting.ProjectDeletionStatus

Indicates whether a project was deleted successfully. If not, this indicates why the project was not deleted.

Enumerator
Success	1
Failure	2	The operation failed for an undefined reason.
ProjectDoesNotExistFailure	3	Cannot delete project with the specified name, as it does not exist in this database.
ActiveProjectFailure	4	Cannot delete project, as it is currently selected as the active project.

◆ PropertyAssignmentStatus

enum HyperX.Scripting.PropertyAssignmentStatus

Enumerator
Success	1
Failure	2	The assignment failed for an undefined reason.
FailureCollectionAssignment	3	The assignment failed for an undefined reason. However, one or more of the property assignments may have succeeded.
PropertyIsNull	4	The specified property is `null`.
PropertyNotFoundInDb	5	The specified property could not be found in the database.
EmptyCollection	6	The specified collection had no entities to assign properties to.
IncompatiblePropertyAssignment	7	The specified property is incompatible with the entity. i.e. Assigning a Non-FEA zone to an FEA load property.
EntityDoesNotExist	8
IncompatibleCategoryAssignment	9

◆ RundeckBulkUpdateStatus

enum HyperX.Scripting.RundeckBulkUpdateStatus

Enumerator
NoRundecksUpdated	0
Success	1
InputFilePathDoesNotExist	2
ResultFilePathDoesNotExist	3
InputFilePathAlreadyExists	4
ResultFilePathAlreadyExists	5
InvalidPathCount	6
RundeckBulkUpdateFailure	7	These rundecks failed an internal validation check that precedes them being committed to the database.
SuccessButIncompatibleFem	8

◆ RundeckCreationStatus

enum HyperX.Scripting.RundeckCreationStatus

Enumerator
Success	1
InputFilePathAlreadyExists	2
ResultFilePathAlreadyExists	3

◆ RundeckRemoveStatus

enum HyperX.Scripting.RundeckRemoveStatus

Enumerator
Success	1
InvalidId	2
CannotRemoveLastRundeck	3
CannotDeletePrimaryRundeck	4
RundeckNotFound	5
RundeckRemoveFailure	6	This rundeck removal failed an internal validation check that precedes it being committed to the database.
SuccessButIncompatibleFem	7

◆ RundeckUpdateStatus

enum HyperX.Scripting.RundeckUpdateStatus

Enumerator
Success	1
InvalidId	2
IdDoesNotExist	3
RundeckAlreadyPrimary	4
InputPathInUse	5
ResultPathInUse	6
RundeckCommitFailure	7	This rundeck failed an internal validation check that precedes it being committed to the database.
InputPathDoesNotExist	8
ResultPathDoesNotExist	9
SuccessButIncompatibleFem	10

◆ SetUnitsStatus

enum HyperX.Scripting.SetUnitsStatus

Enumerator
Success	1
Error	2
MixedUnitSystemError	3	You cannot mix English and SI unit systems for FEM Units.

◆ UnitSystem

enum HyperX.Scripting.UnitSystem

Unit system specified when starting a scripting Application.

Enumerator
English	1
SI	2

◆ ZoneCreationStatus

enum HyperX.Scripting.ZoneCreationStatus

Indicates whether a zone was created successfully. If not, this indicates why the zone was not created.

Enumerator
Success	1
DuplicateNameFailure	2
InvalidFamilyCategory	3

◆ ZoneIdUpdateStatus

enum HyperX.Scripting.ZoneIdUpdateStatus

Enumerator
Success	1
DuplicateIdFailure	2	A zone with this ID is already in use.
IdOutOfRangeError	3	This zone's ID is out of the acceptable range [1 to 99,999,999].

Classes

Enumerations