hyperx.api
Convert a python list to a C#-compatible list.
Used to specify which analysis result to return.
Inherited Members
- enum.Enum
- name
- value
Indicates whether a collection was manipulated successfully.
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Indicates whether a material was created successfully. If not, this indicates why the material was not created.
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Indicates whether a project was created successfully. If not, this indicates why the project was not created.
Inherited Members
- enum.Enum
- name
- value
Indicates whether a project was deleted successfully. If not, this indicates why the project was not deleted.
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Indicates whether a zone was created successfully. If not, this indicates why the zone was not created.
Inherited Members
- enum.Enum
- name
- value
Inherited Members
- enum.Enum
- name
- value
Unit system specified when starting a scripting Application.
Inherited Members
- enum.Enum
- name
- value
Represents an entity with an ID.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Inherited Members
Represents a Margin result.
The adjusted margin for this Margin, if present.
This value may be None when the Margin has a code (see: Margin.MarginCode).
Indicates whether the code is a failure code or not.
If True, Margin.IsInformationalCode should return False.
Indicates whether the code is an informational code or not.
If True, Margin.IsFailureCode should return False.
Returns a failure code when Margin.IsFailureCode is True,
returns an informational code when Margin.IsInformationalCode is True,
or returns hyperx.api.types.MarginCode.Value when the Margin.AdjustedMargin has a value.
The AnalysisDetail.Value can be of any type. This property provides information on the type.
Overload 1: Get(self, name: str) -> AnalysisDetail
Get an AnalysisDetail by name.
Raises
System.InvalidOperationException: If the name is not found.
Overload 2: Get(self, path: tuple[str]) -> AnalysisDetail
Contains result information for an analysis
Returns the Id that can be used to access design case objects from the DesignLoadCol.
Returns
The load case Id or 0 if the load is a user load.
Applicable to User FEA loads and User General loads. Returns the scenario Id.
Contains result information for an analysis
Inherited Members
Contains result information for an analysis
Inherited Members
Contains result information for an analysis
Inherited Members
Contains result information for an analysis
Inherited Members
Contains result information for an analysis
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Setting for a Failure Mode or a Failure Criteria.
Set enum value by index.
Raises
System.InvalidOperationException:
Inherited Members
Inherited Members
Overload 1: Get(self, objectGroup: types.ObjectGroup) -> FailureObjectGroup
Get FailureObjectGroup by hyperx.api.types.ObjectGroup enum.
Overload 2: Get(self, name: str) -> FailureObjectGroup
Overload 3: Get(self, id: int) -> FailureObjectGroup
Inherited Members
Inherited Members
Represents an entity with an ID and Name.
True if the analysis is enabled (None if the object list has inconsistent settings)
Limit/ultimate setting for the analysis (None if the object list has inconsistent settings)
Required margin for the analysis (None if the object list has inconsistent settings)
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Get a FailureCriterion by FailureCriterion.Identifier.
Throws a System.Collections.Generic.KeyNotFoundException if a FailureCriterion with the identifier is not found.
Raises
System.Collections.Generic.KeyNotFoundException:
Overload 1: Get(self, name: str) -> FailureCriterion
Overload 2: Get(self, id: int) -> FailureCriterion
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Overload 1: CreateFailureMode(self, failureModeCategoryId: int, name: str = None) -> FailureMode
Create a FailureMode by Id.
Returns
The created FailureMode.
Overload 2: CreateFailureMode(self, failureModeCategory: str, name: str = None) -> FailureMode
Create a FailureMode by category.
Returns
The created FailureMode.
Overload 1: DeleteFailureMode(self, name: str) -> bool
Delete a FailureMode.
Returns
Falseif there is no failure mode in the collection with the given name.
Overload 2: DeleteFailureMode(self, id: int) -> bool
Delete a FailureMode.
Returns
Falseif there is no failure mode in the collection with the given ID.
Inherited Members
Represents an entity with an ID and Name.
Overload 1: AddFailureMode(self, id: int) -> None
Add a failure mode to the AnalysisProperty by the FailureMode Id.
Overload 2: AddFailureMode(self, ids: tuple[int]) -> None
Adds a collection of failure modes to the AnalysisProperty by the FailureMode Id.
Overload 1: RemoveFailureMode(self, id: int) -> None
Remove a failure mode from the AnalysisProperty by the FailureMode Id.
Overload 2: RemoveFailureMode(self, ids: tuple[int]) -> None
Remove a collection of failure modes from the AnalysisProperty by the FailureMode Id.
Assigns the AnalysisProperty to a collection of entity Ids
where the entity type is determined by the AssignablePropertyWithFamilyCategory.FamilyCategory property.
Returns
PropertyAssignmentStatus.Successif the operation executes successfully.
Inherited Members
Represents an entity with an ID and Name.
Assigns the DesignProperty to a collection of entityIds
where the entity type is determined by the AssignablePropertyWithFamilyCategory.FamilyCategory property.
Returns
PropertyAssignmentStatus.Successif the operation executes successfully.
Inherited Members
Represents an entity with an ID and Name.
Explains where the moment reference is relative to for User FEA or User General Panel Loads.
Returns
Trueif moment reference is relative to zero curvature orFalseto indicate the moment reference is relative to the panel reference plane.
Assign this LoadProperty to entities represented by entityIds.
Returns
PropertyAssignmentStatus.Successif the assignment is successful.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
If the analysis temperature does not have an associated load set id (i.e. the TemperatureChoiceType is equal to Value), the Id will be set to 0 and this field will be false
Inherited Members
Overload 1: Get(self, name: str) -> DesignLoadSubcaseMultiplier
Overload 2: Get(self, id: int) -> DesignLoadSubcaseMultiplier
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID.
Represents an entity with an ID.
Represents a readonly 3D vector.
Represents a table of discrete field data.
Create a new column with the given name. Returns the Id of the newly created column Not valid for discrete fields containing vector data.
Overload 1: ReadNumericCell(self, entityId: int, columnId: int) -> float | None
Valid only for non-point-based discrete fields containing scalar or vector data.
Overload 2: ReadNumericCell(self, pointId: Vector3d, columnId: int) -> float | None
Valid only for point-based discrete fields containing scalar or vector data.
Overload 1: ReadStringCell(self, entityId: int, columnId: int) -> str
Valid only for non point-based discrete fields containing string-based data.
Overload 2: ReadStringCell(self, pointId: Vector3d, columnId: int) -> str
Valid only for point-based discrete fields containing string-based data.
Overload 1: SetNumericValue(self, entityId: int, columnId: int, value: float) -> None
Overload 2: SetNumericValue(self, pointId: Vector3d, columnId: int, value: float) -> None
Overload 1: SetNumericValues(self, valuesByEntityId: dict[int, tuple[float]]) -> None
Set real values for entity based discrete fields in bulk. If an entity is included in the lookup, all values for that entity must be set in the collection of values. If an existing entity is included in the lookup with no values, it will be removed from the dataset.
Raises
System.InvalidOperationException:
Overload 2: SetNumericValues(self, valuesByPoint: dict[Vector3d, tuple[float]]) -> None
Set real values for point based discrete fields in bulk. If a point is included in the lookup, all values for that point must be set in the collection of values. If an existing point is included in the lookup with no values, it will be removed from the dataset.
System.InvalidOperationException:
Overload 1: SetStringValue(self, entityId: int, columnId: int, value: str) -> None
Overload 2: SetStringValue(self, pointId: Vector3d, columnId: int, value: str) -> None
Overload 1: SetStringValues(self, valuesByEntityId: dict[int, tuple[str]]) -> None
Set string values for entity based discrete fields in bulk. If an entity is included in the lookup, all strings for that entity must be set in the collection of strings. If an existing entity is included in the lookup with no strings, it will be removed from the dataset.
Raises
System.InvalidOperationException:
Overload 2: SetStringValues(self, valuesByPoint: dict[Vector3d, tuple[str]]) -> None
Set string values for point based discrete fields in bulk. If a point is included in the lookup, all strings for that point must be set in the collection of strings. If an existing point is included in the lookup with no strings, it will be removed from the dataset.
System.InvalidOperationException:
Delete a specified column for this discrete field. Columns are 1-indexed. Not valid for discrete fields containing vector data.
Delete all rows and columns for this discrete field. Not valid for discrete fields containing vector data.
Inherited Members
Represents an entity with an ID.
Represents an entity with an ID.
Represents an entity with an ID.
Global material direction for plate elements
If setting more than one PlateElement.MaterialDirection, use PlateElementBulkUpdater to avoid major performance hits.
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Get the analysis property assigned to this Entity. Returns None if none is assigned.
Get the design property assigned to this Entity. Returns None if none is assigned.
Get the load property assigned to this Entity. Returns None if none is assigned.
Inherited Members
Abstract base for a Zone or Joint.
Obselete. Use ZoneJointEntity.GetControllingResultsPerCriterion instead.
Overload 1: Get(self, jointSelectionId: types.JointSelectionId) -> JointDesignResult
Get a JointSizingResult for a JointSelectionId
Returns
Null if the item is not found or the item is a JointRangeSizingResult item
Overload 2: Get(self, jointRangeId: types.JointRangeId) -> JointDesignResult
Get a JointSizingResult for a JointRangeId
Returns
Null if the item is not found or the item is a JointSelectionSizingResult item
Overload 3: Get(self, id: int) -> JointDesignResult
Inherited Members
Abstract base for a Zone or Joint.
Obselete. Use ZoneJointEntity.GetControllingResultsPerCriterion instead.
Represents an entity with an ID.
Overload 1: Get(self, parameterId: types.VariableParameter) -> ZoneDesignResult
Overload 2: Get(self, id: int) -> ZoneDesignResult
Inherited Members
Abstract for regular Zones and Panel Segments.
Unlike most entities with IDs, the ID of a Zone can be manually set with the RenumberZone(id) method.
Beam Units: English = lb/ft | Standard = kg/m. Panel Units: English = lb/ft² | Standard = kg/m².
Convenience method for including all design loads in analysis, in the event any have been previously excluded via design load overrides.
Get all analysis results for this zone.
Analysis details must be available to get results.
If analysis details are unavailable, use ZoneBase.GetControllingResultsPerCriterion or rerun analysis to populate them.
Obselete. Use ZoneJointEntity.GetControllingResultsPerCriterion instead.
Inherited Members
Abstract for regular Zones and Panel Segments.
Return elements in the object / skin.
Inherited Members
- ZoneBase
- Centroid
- Id
- Weight
- IncludedDesignLoads
- DesignLoadOverrides
- NonOptimumFactor
- AddedWeight
- SuperimposePanel
- BucklingImperfection
- IsBeamColumn
- SuperimposeBoundaryCondition
- IsZeroOutFeaMoments
- IsZeroOutFeaTransverseShears
- MechanicalLimit
- MechanicalUltimate
- ThermalHelp
- ThermalHurt
- FatigueKTSkin
- FatigueKTStiff
- XSpan
- EARequired
- EI1Required
- EI2Required
- GJRequired
- EAAuto
- EI1Auto
- EI2Auto
- GJAuto
- Ex
- Dmid
- IncludeAllDesignLoads
- GetObjectName
- GetConceptName
- GetZoneDesignResults
- RenumberZone
- GetResults
- GetAllResults
- GetControllingResultsPerCriterion
- GetControllingResult
- GetMinimumMargin
Abstract for regular Zones (not Panel Segments).
Inherited Members
- ZoneBase
- Centroid
- Id
- Weight
- IncludedDesignLoads
- DesignLoadOverrides
- NonOptimumFactor
- AddedWeight
- SuperimposePanel
- BucklingImperfection
- IsBeamColumn
- SuperimposeBoundaryCondition
- IsZeroOutFeaMoments
- IsZeroOutFeaTransverseShears
- MechanicalLimit
- MechanicalUltimate
- ThermalHelp
- ThermalHurt
- FatigueKTSkin
- FatigueKTStiff
- XSpan
- EARequired
- EI1Required
- EI2Required
- GJRequired
- EAAuto
- EI1Auto
- EI2Auto
- GJAuto
- Ex
- Dmid
- IncludeAllDesignLoads
- GetObjectName
- GetConceptName
- GetZoneDesignResults
- RenumberZone
- GetResults
- GetAllResults
- GetControllingResultsPerCriterion
- GetControllingResult
- GetMinimumMargin
Inherited Members
Inherited Members
Inherited Members
Inherited Members
Represents an entity that contains a collection of Zones and Joints.
Overload 1: AddJoint(self, id: int) -> CollectionModificationStatus
Overload 2: AddJoint(self, joint: Joint) -> CollectionModificationStatus
Overload 1: RemoveJoint(self, id: int) -> CollectionModificationStatus
Overload 2: RemoveJoint(self, joint: Joint) -> CollectionModificationStatus
Overload 1: RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemoveJoints(self, joints: tuple[Joint]) -> CollectionModificationStatus
Overload 1: AddZone(self, id: int) -> CollectionModificationStatus
Add an existing zone to this entity.
Overload 2: AddZone(self, zone: Zone) -> CollectionModificationStatus
Add an existing zone to this entity.
Overload 1: AddZones(self, ids: tuple[int]) -> CollectionModificationStatus
Add existing zones to this entity.
Overload 2: AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus
Add existing zones to this entity
Overload 1: RemoveZone(self, id: int) -> CollectionModificationStatus
Overload 2: RemoveZone(self, zone: Zone) -> CollectionModificationStatus
Overload 1: RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemoveZones(self, zones: tuple[Zone]) -> CollectionModificationStatus
Overload 1: AddPanelSegment(self, id: int) -> CollectionModificationStatus
Overload 2: AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus
Add an existing panel segment to this entity
Overload 1: RemovePanelSegment(self, id: int) -> CollectionModificationStatus
Overload 2: RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus
Overload 1: RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemovePanelSegments(self, segments: tuple[PanelSegment]) -> CollectionModificationStatus
Inherited Members
Represents an entity with an ID and Name.
StiffnessCriteriaType of the Automated Constraint>
Add a list of Design Loads to the Automated Constraint by name.
Raises
System.InvalidOperationException: Throws if a Design Load is not valid for the StiffnessCriteriaType.
Remove a list of Design Loads from the AutomatedConstraint by name.
Raises
System.InvalidOperationException: Throws if executing this method would remove all assigned Design Loads.
Inherited Members
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Limit Units:
ConstraintType of Displacement -> English = in | Standard = mm.
ConstraintType of Moment -> English = lbin | Standard = Nmm.
Other ConstraintType -> Unitless.
Inherited Members
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Add a list of Nodes to the Displacement Manual Constraint.
Raises
System.InvalidOperationException: Throws if the Node is not in the FEM.
Remove a list of Nodes from the Displacement Manual Constraint.
Raises
System.InvalidOperationException: Throws if the execution of the method will remove all Nodes.
Add a list of Ref Nodes to the Displacement Manual Constraint.
Raises
System.InvalidOperationException:
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Add an Automated Constraint of type Buckling.
Add an Automated Constraint of type Frequency.
Add an Automated Constraint of type Displacement.
Add an Automated Constraint of type Rotation.
Overload 1: Delete(self, id: int) -> bool
Delete an Automated Constraint by id.
Overload 2: Delete(self, name: str) -> bool
Delete an Automated Constraint by name.
Overload 1: GetBuckling(self, id: int) -> BucklingAutomatedConstraint
Overload 2: GetBuckling(self, name: str) -> BucklingAutomatedConstraint
Overload 1: GetFrequency(self, id: int) -> FrequencyAutomatedConstraint
Overload 2: GetFrequency(self, name: str) -> FrequencyAutomatedConstraint
Overload 1: GetRotation(self, id: int) -> RotationAutomatedConstraint
Overload 2: GetRotation(self, name: str) -> RotationAutomatedConstraint
Overload 1: GetDisplacement(self, id: int) -> DisplacementAutomatedConstraint
Overload 2: GetDisplacement(self, name: str) -> DisplacementAutomatedConstraint
Overload 1: Get(self, name: str) -> AutomatedConstraint
Overload 2: Get(self, id: int) -> AutomatedConstraint
Inherited Members
Overload 1: GetFrequency(self, id: int) -> FrequencyManualConstraint
Overload 2: GetFrequency(self, name: str) -> FrequencyManualConstraint
Overload 1: GetBuckling(self, id: int) -> BucklingManualConstraint
Overload 2: GetBuckling(self, name: str) -> BucklingManualConstraint
Overload 1: GetDisplacement(self, id: int) -> DisplacementManualConstraint
Overload 2: GetDisplacement(self, name: str) -> DisplacementManualConstraint
Overload 1: GetStaticMoment(self, id: int) -> StaticMomentManualConstraint
Overload 2: GetStaticMoment(self, name: str) -> StaticMomentManualConstraint
Add a Manual Constraint of type Frequency.
Add a Manual Constraint of type Buckling.
Add a Manual Constraint of type Static Moment.
Add a Manual Constraint of type Displacement.
Overload 1: DeleteConstraint(self, name: str) -> bool
Delete a Manual Constraint by name.
Returns
False if the constraint is not in the collection.
Overload 2: DeleteConstraint(self, id: int) -> bool
Delete a Manual Constraint by id.
Returns
Return false if the constraint is not in the collection.
Overload 1: Get(self, name: str) -> ManualConstraint
Overload 2: Get(self, id: int) -> ManualConstraint
Inherited Members
Run HyperFEA.
Parameters
- stressReportFormat: In the case where it is , no reports will be generated.
Raises
System.InvalidOperationException:
Overload 1: SetupSolver(self, solverPath: str, arguments: str) -> types.SimpleStatus
Setup FEA solver.
Overload 2: SetupSolver(self, solverPath: str, arguments: str, isBatchRun: bool) -> types.SimpleStatus
Setup the solver command for running FEA.
Parameters
- isBatchRun: Flag that indicates whether to run a custom batch file or the standard solver exectuable.
Represents an entity with an ID and Name.
Inherited Members
Used to specify runsets as an input to some methods.
Foam material temperature dependent properties.
Foam material.
The material family for this material. When the material is saved, a new family will be created if none matching this name exists.
List of this material's temperature-dependent properties.
Adds a temperature-dependent property for a material.
Returns
The newly created temperature-dependent property.
Deletes a temperature-dependent property for a material.
Honeycomb material temperature dependent properties.
Honeycomb material.
The material family for this material. When the material is saved, a new family will be created if none matching this name exists.
List of this material's temperature-dependent properties.
Adds a temperature-dependent property for a material.
Returns
The newly created temperature-dependent property.
Deletes a temperature-dependent property for a material.
Isotropic material temperature dependent properties.
Isotropic material.
The material family for this material. When the material is saved, a new family will be created if none matching this name exists.
List of this material's temperature-dependent properties.
Adds a temperature-dependent property for a material.
Returns
The newly created temperature-dependent property.
Deletes a temperature-dependent property for a material.
Represents an entity with an ID and Name.
Inherited Members
Set the thickness of a layer.
Raises
System.InvalidOperationException: Throws if the material of the layer is set to an orthotropic.
Overload 1: SetMaterial(self, matId: int) -> bool
Sets the material of a layer by id.
Returns
False if the material does not exist.
Overload 2: SetMaterial(self, matName: str) -> bool
Sets the material of a layer by name.
Returns
False if the material does not exist.
Layer in a non-stiffener laminate.
Overload 1: SetMaterial(self, matId: int) -> bool
Sets the material of a layer by id.
Returns
False if the material does not exist.
Overload 2: SetMaterial(self, matName: str) -> bool
Sets the material of a layer by name.
Returns
False if the material does not exist.
Inherited Members
Laminate
Adds a layer to the laminate.
Parameters
- thickness: If the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Returns
The added layer.
Inserts a layer into the laminate before the layer with the specified layerId.
layerId is 1 indexed.
Parameters
- thickness: If the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Returns
The inserted layer.
Stiffener Laminate Layer
Add a layer location to this layer.
Raises
System.InvalidOperationException: Throws if this layer cannot have multiple locations assigned.System.ArgumentException: Throws if the given location is invalid for this layer.
Remove a layer location from LayerLocations.
Returns
False if there is only 1 layer location to start with or if the location is not found.
Overload 1: SetMaterial(self, matId: int) -> bool
Sets the material of a layer by id.
Returns
False if the material does not exist.
Overload 2: SetMaterial(self, matName: str) -> bool
Sets the material of a layer by name.
Returns
False if the material does not exist.
Inherited Members
Stiffener Laminate
Overload 1: AddLayer(self, location: types.StiffenerLaminateLayerLocation, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer
Add layer to stiffener laminate by section.
Parameters
- thickness: If the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Returns
The created StiffenerLaminateLayer.
Raises
System.ArgumentException:
Overload 2: AddLayer(self, locations: tuple[types.StiffenerLaminateLayerLocation], materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer
Add layer to stiffener laminate by collection of sections.
thickness: If the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
System.ArgumentException:
Overload 1: InsertLayer(self, location: types.StiffenerLaminateLayerLocation, layerId: int, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer
Insert layer into stiffener laminate at layerId by section.
layerId is 1 indexed.
Parameters
- thickness: If the material is orthotropic, don't provide a thickness.
Raises
System.ArgumentException:
Overload 2: InsertLayer(self, locations: tuple[types.StiffenerLaminateLayerLocation], layerId: int, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer
Insert layer into stiffener laminate at layerId by collection of sections.
layerId is 1 indexed.
thickness: If the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
System.ArgumentException:
Orthotropic material correction factor.
Pointer to an Equation-based or Tabular Correction Factor.
Orthotropic material equation-based correction factor value. (NOT TABULAR)
Property for the correction factor containing this value.
Correction ID for the correction factor containing this value.
Equation for the correction factor containing this value.
Represents a parameter for a given equation. Specify with the EquationParameterName enum.
Represents an equation-based orthotropic material correction factor.
Dictionary of correction factor values for this correction factor.
Add a correction factor value for a given correction factor.
Parameters
- equationParameterName: This represents the parameter of the equation that should be changed.
- valueToAdd: This is the value that will be assigned to the chosen parameter.
Inherited Members
Contains an independent value for a tabular correction factor row.
Row data for a tabular correction factor.
Data for the "independent values" on the given row, mapped by their CorrectionIndependentDefinition. This is everything but the "dependent value", i.e. the last value on the row on the form.
Tabular correction factor.
Determine the correction factor rows for this tabular correction factor. Map of correctionPointId to row.
These correspond to the independent values for this correction factor. These are represented by the column headers on the correction factors form in the UI.
Overload 1: SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: float) -> None
Set independent value for a specified row and the independent value within the row.
Overload 2: SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: bool) -> None
Set independent value for a specified row and the independent value within the row.
Overload 3: SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: int) -> None
Set independent value for a specified row and the independent value within the row.
Set the dependent value for a specified row.
Inherited Members
Represents a point on a laminate allowable curve.
This represents either an X value for an AML or Percent0/45 Degree Fibers method, or an AllowablePolynomialCoefficient enumeration representing which coefficient will be entered.
Orthotropic material effective laminate properties. Read-only from the API. Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.
Orthotropic material laminate allowable properties.
Orthotropic material temperature dependent properties.
Access the relevant curve points based on the material's selection of method or polynomial.
Add a curve point to a laminate allowable curve.
Parameters
- x: x represents an x-value (for a non-polynomial method) or an allowable polynomial coefficient (represented by an enum).
Returns
The newly created curve point.
Deletes a temperature-dependent property for a material.
Parameters
- x: x represents an x-value (for a non-polynomial method) or an allowable polynomial coefficient (represented by an enum).
Retrieve an allowable curve point from this temperature's allowable curve points.
Parameters
- x: x represents an x-value (for a non-polynomial method) or an allowable polynomial coefficient (represented by an enum).
Returns
The Laminate Allowable, if a matching one was found. Returns
Noneif none exists.
Orthotropic material.
The material family for this material. When the material is saved, a new family will be created if none matching this name exists.
List of this material's temperature-dependent properties.
List of this material's laminate allowable properties.
Contains Effective Laminate data if this material is an effective laminate, otherwise None.
Dictionary of this material's equation-based correction factors.
Dictionary of this material's tabular correction factors.
Adds a temperature-dependent property for a material.
Returns
The newly created temperature-dependent property.
Deletes a temperature-dependent property for a material.
Retrieve a Temperature from this material's temperature-dependent properties. Allows a degree of tolerance to avoid issues with floating point numbers.
Parameters
- LookupTemperature: Temperature to search for.
Returns
The temperature, if a matching one was found. Returns
Noneif none exists.
Adds a laminate allowable to this material. An orthotropic material can only have one laminate allowable of each property (as specified by the property argument).
Parameters
- property: The strain or stress property for a laminate allowable.
- method: The method for a laminate allowable (AML, Percent 0/45, Polynomial).
Returns
The newly created laminate allowable.
Retrieve a Laminate allowable from this material's laminate allowables.
Parameters
- LookupAllowableProperty: Laminate allowable property to search for.
Returns
The Laminate Allowable, if a matching one was found. Returns
Noneif none exists.
Adds an equation-based correction factor for this material.
Parameters
- propertyId: The ID of the property to be affected by the correction factor. Specified with a CorrectionPropertyName enum.
- correctionId: The ID for the type of correction factor to be applied. Specified with a CorrectionIDName enum.
- equationId: The ID for the type of correction factor equation to use. Specified with a CorrectionEquationName enum.
Returns
The newly created correction factor.
Retrieve a Correction Factor from this material's correction factors.
Parameters
- property: CorrectionPropertyName to search for.
- correction: CorrectionIDName to search for.
Returns
The OrthotropicCorrectionFactor, if a matching one was found. Returns
Noneif none exists.
Retrieve a Correction Factor from this material's correction factors.
Parameters
- property: CorrectionPropertyName to search for.
- correction: CorrectionIDName to search for.
Returns
The OrthotropicCorrectionFactor, if a matching one was found. Returns
Noneif none exists.
Represents a readonly 2D vector.
A set of elements defined in the input file.
Inherited Members
A property description.
Inherited Members
Inherited Members
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID.
This returns true for the primary rundeck. Note that the primary rundeck always has ID 1.
The rundeck's input file path will point to the provided file path
Parameters
- filepath: The path to the rundeck
Represents an entity with an ID and Name.
Set the zone stiffness distribution. This should be a value between 0 and 1. Values closer to 0 are more even and heavier. Values closer to 1 are more targeted and lighter.
Set this Section Cut's horizontal vector to be equal to its principal axis horizontal vector.
Set this Section Cut's horizontal vector to be equal to its principal axis vertical vector.
Inherited Members
Represents an entity that contains a collection of Zones and Joints.
Overload 1: AddJoint(self, joint: Joint) -> CollectionModificationStatus
Overload 2: AddJoint(self, id: int) -> CollectionModificationStatus
Overload 1: AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus
Overload 2: AddPanelSegment(self, id: int) -> CollectionModificationStatus
Overload 1: AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus
Overload 2: AddZones(self, ids: tuple[int]) -> CollectionModificationStatus
Add existing zones to this entity.
Overload 1: RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemoveJoints(self, joints: tuple[Joint]) -> CollectionModificationStatus
Overload 1: RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemovePanelSegments(self, segments: tuple[PanelSegment]) -> CollectionModificationStatus
Overload 1: RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemoveZones(self, zones: tuple[Zone]) -> CollectionModificationStatus
Overload 1: RemoveJoint(self, id: int) -> CollectionModificationStatus
Overload 2: RemoveJoint(self, joint: Joint) -> CollectionModificationStatus
Overload 1: AddZone(self, id: int) -> CollectionModificationStatus
Add an existing zone to this entity.
Overload 2: AddZone(self, zone: Zone) -> CollectionModificationStatus
Add an existing zone to this entity.
Overload 1: RemoveZone(self, id: int) -> CollectionModificationStatus
Overload 2: RemoveZone(self, zone: Zone) -> CollectionModificationStatus
This feature is in development and may not work as expected. Use at your own risk!
Inherited Members
Represents an entity that contains a collection of Zones and Joints.
Overload 1: AddJoint(self, joint: Joint) -> CollectionModificationStatus
Overload 2: AddJoint(self, id: int) -> CollectionModificationStatus
Overload 1: AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus
Overload 2: AddPanelSegment(self, id: int) -> CollectionModificationStatus
Overload 1: AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus
Overload 2: AddZones(self, ids: tuple[int]) -> CollectionModificationStatus
Add existing zones to this entity.
Overload 1: Remove(self, zoneIds: tuple[int], jointIds: tuple[int]) -> CollectionModificationStatus
Overload 2: Remove(self, zoneIds: tuple[int], jointIds: tuple[int], panelSegmentIds: tuple[int]) -> CollectionModificationStatus
Overload 1: RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemoveJoints(self, joints: tuple[Joint]) -> CollectionModificationStatus
Overload 1: RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus
Overload 2: RemovePanelSegments(self, segments: tuple[PanelSegment]) -> CollectionModificationStatus
Overload 1: RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus
Sends provided zones back to unused FEM
Overload 2: RemoveZones(self, zones: tuple[Zone]) -> CollectionModificationStatus
Overload 1: RemoveJoint(self, id: int) -> CollectionModificationStatus
Overload 2: RemoveJoint(self, joint: Joint) -> CollectionModificationStatus
Overload 1: AddZone(self, id: int) -> CollectionModificationStatus
Add an existing zone to this entity.
Overload 2: AddZone(self, zone: Zone) -> CollectionModificationStatus
Add an existing zone to this entity.
Overload 1: RemoveZone(self, id: int) -> CollectionModificationStatus
Overload 2: RemoveZone(self, zone: Zone) -> CollectionModificationStatus
Creates and returns an AnalysisProperty.
HyperX will handle any naming conflicts, so it is important to use the returned AnalysisProperty
which may have a different name to what was provided.
Returns
The created
AnalysisProperty.
Overload 1: DeleteAnalysisProperty(self, name: str) -> bool
Delete an AnalysisProperty.
Returns
Falseif there is no analysis property in the collection with the given name.
Overload 2: DeleteAnalysisProperty(self, id: int) -> bool
Delete an AnalysisProperty.
Returns
Falseif there is no analysis property in the collection with the given ID.
Overload 1: Get(self, name: str) -> AnalysisProperty
Overload 2: Get(self, id: int) -> AnalysisProperty
Inherited Members
Creates and returns a DesignProperty.
HyperX will handle any naming conflicts, so it is important to use the returned DesignProperty
which may have a different name to what was provided.
Returns
The created
DesignProperty.
Overload 1: DeleteDesignProperty(self, name: str) -> bool
Delete a DesignProperty.
Returns
Falseif there is no design property in the collection with the given name.
Overload 2: DeleteDesignProperty(self, id: int) -> bool
Delete a DesignProperty.
Returns
Falseif there is no design property in the collection with the given ID.
Inherited Members
Creates and returns a new LoadProperty.
HyperX will handle any naming conflicts, so it is important to use the returned LoadProperty
which may have a different name to what was provided.
Returns
The created
LoadProperty.
Overload 1: DeleteLoadProperty(self, id: int) -> bool
Remove a LoadProperty by id.
Returns
Trueif successfully deleted.
Overload 2: DeleteLoadProperty(self, name: str) -> bool
Remove a LoadProperty by name.
Returns
Trueif successfully deleted.
Inherited Members
Options to determine how design load filtering is applied or updated during sizing and analysis.
Set the DesignLoad.IsActive></see> flag for a set ofDesignLoad> based on the isActive parameter.
Set the DesignLoad.IsActive></see> flag for a set ofDesignLoad> based on the isActive parameter.
Inherited Members
Create a new DiscreteField.
Returns
The created DiscreteField.
Create a list of DiscreteFields from VCP.
Returns
The list of created DiscreteFields.
Raises
System.InvalidOperationException:
In the event of getting a CollectionModificationStatus.EntityMissingRemovalFailure, note that the discrete field is associated with a ply, and therefore cannot be deleted.
Create Discrete Fields by mapping existing Point-based Discrete Fields to new element-based Discrete Fields.
Returns
The list of created DiscreteFields.
Raises
System.InvalidOperationException:
Inherited Members
Inherited Members
Inherited Members
The specified rundeck at the given filepath will be added to the project's collection of rundecks
Parameters
- inputPath: The path to the rundeck
- resultPath: The path to the rundeck's corresponding result file
The specified rundeck will be updated to become the new primary rundeck.
It is best practice to call Project.RegeneratePfem after
reassigning the primary rundeck
The specified rundeck at the given filepath will be removed from the project's collection of rundecks
Parameters
- id: The id of the rundeck to remove
Updates the path of all rundecks. The order of newPaths should correspond with the rundeck ids (i.e. The first item in newPaths will update the primary rundeck's paths).
Replace a given string with a new string in every rundeck path. This is useful when pointing to rundecks of the same name in a new directory.
Inherited Members
Inherited Members
Attempt to create a new Set.
Parameters
- name: The name of the set to be created.
Returns
The created Set.
Inherited Members
Attempt to create a new structure. If the specified name is already used, it will be deconflicted.
Parameters
- name: The name of the structure to be created.
Returns
Return the new Structure
Overload 1: DeleteStructure(self, structure: Structure) -> bool
Returns true if the structure was deleted from the collection. Returns false if the structure could not be found or if there are run sets in the project.
Overload 2: DeleteStructure(self, name: str) -> bool
Returns true if the structure was deleted from the collection. Returns false if the structure could not be found or if there are run sets in the project.
Overload 3: DeleteStructure(self, id: int) -> bool
Returns true if the structure was deleted from the collection. Returns false if the structure could not be found or if there are run sets in the project.
Inherited Members
Represents a HyperX project within a database.
Does some checks to make sure the given parameters are valid, then uploads the given zones and joints to the Dashboard. The URL and authentication token are taken from the last Dashboard login made through HyperX.
Parameters
- uploadSetName: The name of the set of data uploaded to the Dashboard.
- company: The name of the company to associate with the upload set. This company object must be made through the Dashboard UI.
- program: The name of the program to associated with the upload set. A new program will be created if the program name does not already exist.
- tags: The list of tags to be associated with the upload set. Any tags that do not exist will be created automatically on upload.
- notes: The notes to be associated with the upload set.
- zoneIds: The zone IDs to include in the upload set.
- jointIds: The joint IDs to include in the upload set.
Returns
Returns a successful SimpleStatus if the upload succeeded. Returns an unsuccessful SimpleStatus with error info otherwise.
This method fetches an array of Dashboard company names that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX.
Returns
Returns an array of company names. If certain web related errors are encountered, an empty array will be returned.
This method fetches an array of Dashboard program names that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX.
Returns
Returns an array of program names. If certain web related errors are encountered, an empty array will be returned. If the provided company cannot be found, a
Nonevalue will be returned.
This method fetches an array of Dashboard tags that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX.
Returns
Returns an array of tag names. If certain web related errors are encountered, an empty array will be returned. If the provided company could not be found, a
Nonevalue will be returned.
Create a .hxp project package from the ActiveProject.
Manually import design loads.
Parameters
- alwaysImport: If true, loads are imported even if loads have already previously been imported.
Returns
Any warnings during import. String with length 0 if no warnings.
Raises
System.InvalidOperationException: Throws on failure.
Given a list of joints, returns the ids of the joints that were passed in but did not have results. If the list of joints is not a subset of the joints passed into the previous joint sizing operation, a new sizing operation will be kicked off.
Overload 1: AnalyzeZones(self, zones: tuple[ZoneBase] = None) -> types.TernaryStatus
Analyze a list of zones. Marked as success if sizing completes normally or with warnings.
Overload 2: AnalyzeZones(self, zoneIds: tuple[int]) -> types.TernaryStatus
Analyze a list of zones by ID. Marked as success if sizing completes normally or with warnings.
Overload 1: SizeZones(self, zones: tuple[ZoneBase] = None) -> types.TernaryStatus
Size a list of zones. Marked as success if sizing completes normally or with warnings.
Parameters
- zones: The zones to be sized.
Overload 2: SizeZones(self, zoneIds: tuple[int]) -> types.TernaryStatus
Size a list of zones by ID. Marked as success if sizing completes normally or with warnings.
Return zones to unused FEM or delete non-FEA zones.
Raises
System.InvalidOperationException: Throws if run sets exist in this project.
Overload 1: ExportCad(self, filePath: str) -> None
Export all CAD for this project to a file.
Overload 2: ExportCad(self, cadIds: tuple[int], filePath: str) -> None
Export CAD by Id.
Regenerates and displays the preview FEM. If running a script outside of the Script Runner, do not call this method
Overload 1: CopyResultsToOverrides(self, forceDeletePlies: bool, zones: tuple[ZoneBase]) -> types.SimpleStatus
Overload 2: CopyResultsToOverrides(self, forceDeletePlies: bool, zoneIds: tuple[int]) -> types.SimpleStatus
Create HyperXpert points based on specific run sets.
Represents an entity with an ID and Name.
Inherited Members
Overload 1: Get(self, name: str) -> FailureModeCategory
Overload 2: Get(self, id: int) -> FailureModeCategory
Inherited Members
Create a Foam material.
Parameters
- femId: Defaults to 0 when there is no linked FEM.
Returns
The created Foam.
Raises
System.ArgumentException: Throws on duplicate femId.
Check if an honeycomb material exists in this collection.
Create a Honeycomb material.
Parameters
- femId: Defaults to 0 when there is no linked FEM.
Returns
The created Honeycomb.
Raises
System.ArgumentException: Throws on duplicate femId.
Check if an isotropic material exists in this collection.
Create an Isotropic material.
Parameters
- femId: Defaults to 0 when there is no linked FEM.
Returns
The created Isotropic.
Raises
System.ArgumentException: Throws on duplicate femId.
Inherited Members
Create a stiffener laminate.
Returns
The created stiffener laminate.
Copy a laminate material by name.
Returns
The copied laminate.
Raises
System.ArgumentException: Throws if the laminate to copy doesn't exist.
Delete a laminate material by name. Returns false if the material is not found or removed.
Check if an orthotropic material exists in this collection.
Create an Orthotropic material.
Parameters
- femId: Defaults to 0 when there is no linked FEM.
Returns
The created Orthotropic.
Raises
System.ArgumentException: Throws on duplicate femId.
Copy an Orthotropic material.
Parameters
- femId: Defaults to 0 when there is no linked FEM.
Returns
The new copied Orthotropic.
Raises
System.ArgumentException: Throws on nonexistent Orthotropic material to copy or duplicate femId.
Delete an orthotropic material by name. Returns false if the method the material is not found.
Generate effective laminates with the specified ply angle constraints.
Raises
System.ArgumentException:
Create an effective laminate with the specified ply angle percentages.
Raises
System.ArgumentException:
Overload 1: RemovePluginPackage(self, name: str) -> bool
Remove a plugin package by name.
Returns
False if the package is not found.
Overload 2: RemovePluginPackage(self, id: int) -> bool
Remove a plugin package by id.
Returns
False if the package is not found.
Gets a list of package info Includes name, id, file path, version, description, and modification date
Returns
A list of all packages in the collection.
Inherited Members
Inherited Members
HyperX scripting application. This API is not guaranteed to be thread-safe. Calls into a single application instance or its descendents are not safe to be called concurrently.
However, it is safe enough for integration testing to have multiple application instances with a single process.
Pause the sending of updates as items are created.Once resumed, all updates will be processed.
Resume the sending of updates.Any paused updates will be processed.
Unpackage the source .hxp package into the destination folder. The destination folder should be empty.
Close the currently open database if one exists.
Parameters
- delay: Delay closing the connection for this many seconds.
Copy a project
Parameters
- projectId: Id of the project to copy
- newName: Name for the new project
- copyDesignProperties: Flag indicating whether design properties should be copied in the new project
- copyAnalysisProperties: Flag indicating whether analysis properties should be copied in the new project
- copyLoadProperties: Flag indicating whether load properties should be copied in the new project
- copyWorkingFolder: Flag indicating whether working folder should be copied
Returns
The ProjectInfo for the copied project.
Create a new database.
Parameters
- templateName: The name of the template to base this database on.
- newPath: The path to the new database.
Dispose of the application. Should be explicitly called after the application is no longer needed unless the application is wrapped with a using clause.
Login to the Scripting API with a specified username and password.
Parameters
- userName: Username to login with.
- password: Password to log in with
Migrate the database to the latest version.
Returns
File path to the new database file
Returns true if the database version matches the version of this scripting API. Otherwise returns false.
Open a database to manipulate with the API.
Parameters
- databasePath: File path to the DB.
Import materials from an Excel spreadsheet. Returns true on successful import.
Parameters
- deletePlies: Determines whether to update laminate or laminate families with changes that will delete plies in structures.
- updateMaterialsInUseInOtherProjects: Determines whether to update materials in use by projects outside the active project.
Create HyperXpert points based on specific run sets.
Represents an entity with an ID.
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID.
Overload 1: Get(self, name: str) -> SizingMaterial
Get a sizing material by name.
Raises
System.ArgumentException: Throws if the material is not in the database or if the material is not in the list of sizing materials.
Overload 2: Get(self, id: int) -> SizingMaterial
Overload 1: Contains(self, name: str) -> bool
Check if the list of sizing materials contains a material by name.
Returns
Falseif the material does not exist in the database or is not in the list of sizing materials.
Overload 2: Contains(self, id: int) -> bool
Overload 1: AddSizingMaterial(self, materialId: int) -> bool
Add a SizingMaterial by materialId to the list of sizing materials.
Returns
Falseif the material was not found.
Raises
System.InvalidOperationException:
Overload 2: AddSizingMaterial(self, name: str) -> bool
Add a SizingMaterial by name to the list of sizing materials.
Returns
Falseif the material was not found.
System.InvalidOperationException:
Add a set of SizingMaterial by materialNames to the list of sizing materials.
Returns
hyperx.api.types.TernaryStatuswith information about whether materials were successfully added or failed.
Raises
System.InvalidOperationException:
Add a set of SizingMaterial by materialIds to the list of sizing materials.
Returns
hyperx.api.types.TernaryStatuswith information about whether materials were successfully added or failed.
Raises
System.InvalidOperationException:
Overload 1: RemoveSizingMaterial(self, materialId: int) -> bool
Remove a SizingMaterial by materialId from the list of sizing materials.
Returns
Falseif the material is not in the list of sizing materials.
Overload 2: RemoveSizingMaterial(self, name: str) -> bool
Remove a SizingMaterial by name from the list of sizing materials.
Returns
Falseif the material is not in the list of sizing materials.
Raises
System.InvalidOperationException:
Remove a set of SizingMaterial by materialIds from the list of sizing materials.
Returns
hyperx.api.types.TernaryStatuswith information about whether materials were successfully removed or failed.
Raises
System.InvalidOperationException:
Remove a set of SizingMaterial by materialNames from the list of sizing materials.
Returns
hyperx.api.types.TernaryStatuswith information about whether materials were successfully removed or failed.
Raises
System.InvalidOperationException:
Remove all SizingMaterial from the list of sizing materials.
Inherited Members
Represents an entity with an ID.
The hyperx.api.types.BeamPanelFamily Id associated with this override.
Minimum sizing bound for this override.
You cannot set a ZoneOverride.MinBound if your override sizing materials are laminate hyperx.api.types.MaterialType.
Raises
System.InvalidOperationException: In the case of laminates, the is , and setting it will throw an error.
Maximum sizing bound for this override.
You cannot set a ZoneOverride.MaxBound if your override sizing materials are laminate hyperx.api.types.MaterialType.
In the case of laminates, the ZoneOverride.MaxBound is None, and setting it will throw an error.
Sizing step size for this override.
You cannot set a ZoneOverride.StepSize if your override sizing materials are laminate hyperx.api.types.MaterialType.
In the case of laminates, the ZoneOverride.StepSize is None, and setting it will throw an error.
Ply-based sizing min bound for this override. Applicable to Effective Laminate sizing where the sizing dimension is plies.
Ply-based sizing max bound for this override. Applicable to Effective Laminate sizing where the sizing dimension is plies.
Ply-based sizing step size for this override. Applicable to Effective Laminate sizing where the sizing dimension is plies.
Get and set analysis value.
You cannot set an analysis value if your analysis material is a laminate hyperx.api.types.MaterialType.
In the case of a laminate, the analysis value is None, and setting it will throw an error.
Get and set the analysis material by name.
Raises
System.Exception: If no analysis material is set when trying to get the
Tooling constraints are a feature of Design Properties for Zones.
The value for this ToolingConstraint.
Use ToolingConstraint.ToolingSelectionType to determine how this value is used.
Defines which hyperx.api.types.ToolingSelectionType a given tooling constraint is currently set to.
Set the tooling constraint to an inequality if the constraint type is an inequality.
Sets the ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.SpecifiedLimitOrRange.
Raises
System.InvalidOperationException: If the constraint type is not an inequality.
Set the tooling constraint to a range if the constraint type is a range.
Sets the ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.SpecifiedLimitOrRange.
Raises
System.InvalidOperationException: If the constraint type is not .
Set the tooling constraint to a value.
Sets the ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.SpecifiedValue.
Raises
System.InvalidOperationException:
Inherited Members
Inherited Members
Holds design variable data. Min, max, steps, materials.
Returns True if this design variable is dependent on other design variables.
Maximum bound for this row.
You cannot set a Max if your DesignVariable.SizingMaterialType is a laminate hyperx.api.types.MaterialType.
In the case of laminates, the Max is determined by the laminate thickness, and setting it will throw an error.
Minimum bound for this row.
You cannot set a Min if your DesignVariable.SizingMaterialType is a laminate hyperx.api.types.MaterialType.
In the case of laminates, the Min is determined by the laminate thickness, and setting it will throw an error.
Step size for this row.
You cannot set a StepSize if your DesignVariable.SizingMaterialType is a laminate hyperx.api.types.MaterialType.
In the case of laminates, the StepSize is None, and setting it will throw an error.
Get and set analysis value
You cannot set an analysis value if your analysis material is a laminate hyperx.api.types.MaterialType.
In the case of a laminate, the analysis value is derived from thickness, and setting it will throw an error.
Overload 1: AddMaterials(self, materialIds: set[int]) -> None
Obsolete use DesignVariable.SizingMaterials instead.
Add sizing materials by material Id.
Overload 2: AddMaterials(self, materialNames: set[str]) -> None
Obsolete use DesignVariable.SizingMaterials instead.
Add sizing materials by material Name.
Obsolete use DesignVariable.SizingMaterials instead.
Get a list of material Ids used for sizing, if they exist.
Obsolete use DesignVariable.SizingMaterials instead.
Remove sizing materials assigned to this variable by a collection of Ids.
Parameters
- materialIds: If not specified, remove all materials.
Obsolete use DesignVariable.AnalysisMaterial instead.
Get the material used for analysis, if it exists.
Overload 1: Get(self, fabricationRatioId: types.FabricationRatio) -> FabricationCriterionRatio
Overload 2: Get(self, id: int) -> FabricationCriterionRatio
Inherited Members
Overload 1: Get(self, name: str) -> ToolingConstraint
Overload 2: Get(self, id: int) -> ToolingConstraint
Inherited Members
Overload 1: Get(self, parameterId: types.VariableParameter) -> DesignVariable
Gets a DesignVariable from a hyperx.api.types.VariableParameter.
Raises
System.ArgumentException: If the design property does not contain the requested .
Overload 2: Get(self, id: int) -> DesignVariable
Inherited Members
Represents an entity with an ID and Name.
Get a ToolingConstraint collection for this ZoneDesignProperty.
Gets a FabricationCriterionRatioCol of fabrication criterion ratios.
Inherited Members
Inherited Members
Represents an entity with an ID and Name.
Mechanical => Pressure: Units: English = psi | Standard = MPa. Thermal => Temperature: Units: English = °F | Standard = °C.
Inherited Members
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Axial Units: English = lb | Standard = N. Strain Units: English = µin/in | Standard = µm/m.
Force => Axial | Displacement => ε | Free => Free | Fixed => Fixed.
Force => Torque | Displacement => φ | Free => Free | Fixed => Fixed.
Inherited Members
Represents an entity with an ID and Name.
Unit Force Units: English = lb/in | Standard = N/mm. Strain Units: English = µin/in | Standard = µm/m.
Unit Force Units: English = lb/in | Standard = N/mm. Strain Units: English = µin/in | Standard = µm/m.
Unit Force Units: English = lb/in | Standard = N/mm. Strain Units: English = µin/in | Standard = µm/m.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Moment Units: English = lbin | Standard = Nmm. Curvature Units: English = 1/in | Standard = 1/mm.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Represents an entity with an ID and Name.
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Delete a load scenario by id.
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Delete a load scenario by name.
Inherited Members
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Overload 1: Get(self, name: str) -> LoadPropertyUserFeaBeamRow
Overload 2: Get(self, id: int) -> LoadPropertyUserFeaBeamRow
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Overload 1: Get(self, name: str) -> LoadPropertyUserFeaJointRow
Overload 2: Get(self, id: int) -> LoadPropertyUserFeaJointRow
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Overload 1: Get(self, name: str) -> LoadPropertyUserFeaPanelRow
Overload 2: Get(self, id: int) -> LoadPropertyUserFeaPanelRow
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Delete scenario by ID.
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Delete scenario by ID.
Inherited Members
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Overload 1: Get(self, name: str) -> LoadPropertyUserGeneralBeamDoubleRow
Overload 2: Get(self, id: int) -> LoadPropertyUserGeneralBeamDoubleRow
Inherited Members
Represents an entity with an ID and Name.
Bool indicating whether there is a row in each scenario for thermal loads. Setting adds a thermal row for every "double row" in the collection. To see this change on any rows, you must get the row from the collection again.
Inherited Members
Represents an entity with an ID.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID.
Force => Ny | Displacement => v | Free => Free | Fixed => Fixed.
Force => My | Displacement => β | Free => Free | Fixed => Fixed.
Force => Qy | Displacement => w | Free => Free | Fixed => Fixed.
Force => Nxy | Displacement => u | Free => Free | Fixed => Fixed.
Unit Force Units: English = lb/in | Standard = N/mm. Length Units: English = in | Standard = mm.
Unit Force Units: English = lb/in | Standard = N/mm. Length Units: English = in | Standard = mm.
Inherited Members
Represents an entity with an ID.
Bonded joint concept; UserGeneralBondedRows will automatically be updated upon changing Joint Concept Id, so any data will be cleared
Represents an entity with an ID and Name.
Inherited Members
Represents an entity with an ID and Name.
Inherited Members
Overload 1: DeleteScenario(self, scenarioId: int) -> bool
Overload 2: DeleteScenario(self, scenarioName: str) -> bool
Overload 1: Get(self, name: str) -> LoadPropertyUserGeneralPanelDoubleRow
Overload 2: Get(self, id: int) -> LoadPropertyUserGeneralPanelDoubleRow
Inherited Members
Represents an entity with an ID and Name.
Bool indicating whether there is a row in each scenario for thermal loads. Setting adds a thermal row for every "double row" in the collection. To see this change on any rows, you must get the row from the collection again.
Inherited Members
Represents an entity with an ID.
Represents an entity with an ID.
Inherited Members
Represents an entity with an ID.
Inherited Members
Represents an entity with an ID.
Represents an entity with an ID.
Inherited Members
Inherited Members
Represents HyperX's execution environment (where HyperX is installed).
Set the directory location of the HyperX binaries.
- This method is not required for Python and IronPython client application.
- This method is required for C# and VB.NET clients as these applications need HyperX.Scripting.dll alongside its binaries.
Parameters
- location: Path to the binaries.
Setting for a Failure Criteria.
Setting for a Failure Mode.
Per ply data for Laminate materials
IMPORTANT: This is the ID of the laminate to which this ply belongs, different than LaminatePlyData.PlyMaterialId
Abstract for regular Zones (not Panel Segments).
Inherited Members
- ZoneBase
- Centroid
- Id
- Weight
- IncludedDesignLoads
- DesignLoadOverrides
- NonOptimumFactor
- AddedWeight
- SuperimposePanel
- BucklingImperfection
- IsBeamColumn
- SuperimposeBoundaryCondition
- IsZeroOutFeaMoments
- IsZeroOutFeaTransverseShears
- MechanicalLimit
- MechanicalUltimate
- ThermalHelp
- ThermalHurt
- FatigueKTSkin
- FatigueKTStiff
- XSpan
- EARequired
- EI1Required
- EI2Required
- GJRequired
- EAAuto
- EI1Auto
- EI2Auto
- GJAuto
- Ex
- Dmid
- IncludeAllDesignLoads
- GetObjectName
- GetConceptName
- GetZoneDesignResults
- RenumberZone
- GetResults
- GetAllResults
- GetControllingResultsPerCriterion
- GetControllingResult
- GetMinimumMargin
Inherited Members
Inherited Members
Abstract for regular Zones (not Panel Segments).
Inherited Members
- ZoneBase
- Centroid
- Id
- Weight
- IncludedDesignLoads
- DesignLoadOverrides
- NonOptimumFactor
- AddedWeight
- SuperimposePanel
- BucklingImperfection
- IsBeamColumn
- SuperimposeBoundaryCondition
- IsZeroOutFeaMoments
- IsZeroOutFeaTransverseShears
- MechanicalLimit
- MechanicalUltimate
- ThermalHelp
- ThermalHurt
- FatigueKTSkin
- FatigueKTStiff
- XSpan
- EARequired
- EI1Required
- EI2Required
- GJRequired
- EAAuto
- EI1Auto
- EI2Auto
- GJAuto
- Ex
- Dmid
- IncludeAllDesignLoads
- GetObjectName
- GetConceptName
- GetZoneDesignResults
- RenumberZone
- GetResults
- GetAllResults
- GetControllingResultsPerCriterion
- GetControllingResult
- GetMinimumMargin