HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.StiffenerLaminate Class Reference

Stiffener Laminate. More...

Inheritance diagram for hyperx.api.StiffenerLaminate:
hyperx.api.LaminateBase

Public Member Functions

 __init__ (self, _api.StiffenerLaminate stiffenerLaminate)
StiffenerLaminateLayer AddLayer (self, item1=None, item2=None, item3=None, item4=None)
StiffenerLaminateLayer AddLayer (self, tuple[types.StiffenerLaminateLayerLocation] locations, str materialName, float angle, float thickness=None)
 Add layer to stiffener laminate by collection of sections.
StiffenerLaminateLayer AddLayer (self, types.StiffenerLaminateLayerLocation location, str materialName, float angle, float thickness=None)
 Add layer to stiffener laminate by section.
StiffenerLaminateLayer InsertLayer (self, item1=None, item2=None, item3=None, item4=None, item5=None)
StiffenerLaminateLayer InsertLayer (self, tuple[types.StiffenerLaminateLayerLocation] locations, int layerId, str materialName, float angle, float thickness=None)
 Insert layer into stiffener laminate at layerId by collection of sections.
StiffenerLaminateLayer InsertLayer (self, types.StiffenerLaminateLayerLocation location, int layerId, str materialName, float angle, float thickness=None)
 Insert layer into stiffener laminate at layerId by section.
bool RemoveLayer (self, int layerId)
 Remove a layer by layerId.
None Save (self)
 Save laminate to database.
Public Member Functions inherited from hyperx.api.LaminateBase
 __init__ (self, _api.LaminateBase laminateBase)

Properties

 LaminateStiffenerProfile = property
 Layers = property
 Laminate layers.
Properties inherited from hyperx.api.LaminateBase
 Density = property
 Density.
 HyperLaminate = property
 Id = property
 IsEditable = property
 LaminateFamilyId = property
 LaminateFamilyOrder = property
 LayerCount = property
 The total number of layers in this laminate.
 MaterialFamilyName = property
 Name = property
 Thickness = property
 Thickness.

Additional Inherited Members

Protected Attributes inherited from hyperx.api.LaminateBase
 _Entity = laminateBase

Detailed Description

Stiffener Laminate.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.StiffenerLaminate.__init__ ( self,
_api.StiffenerLaminate stiffenerLaminate )

Member Function Documentation

◆ AddLayer() [1/3]

StiffenerLaminateLayer hyperx.api.StiffenerLaminate.AddLayer ( self,
item1 = None,
item2 = None,
item3 = None,
item4 = None )
   Add layer to stiffener laminate by section.
Parameters
thicknessIf the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Returns
The created StiffenerLaminateLayer.
Exceptions
ArgumentException
Returns

   Add layer to stiffener laminate by collection of sections.
Parameters
thicknessIf the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Exceptions
ArgumentException

◆ AddLayer() [2/3]

StiffenerLaminateLayer hyperx.api.StiffenerLaminate.AddLayer ( self,
tuple[types.StiffenerLaminateLayerLocation] locations,
str materialName,
float angle,
float thickness = None )

Add layer to stiffener laminate by collection of sections.

Parameters
thicknessIf the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Exceptions
ArgumentException

◆ AddLayer() [3/3]

StiffenerLaminateLayer hyperx.api.StiffenerLaminate.AddLayer ( self,
types.StiffenerLaminateLayerLocation location,
str materialName,
float angle,
float thickness = None )

Add layer to stiffener laminate by section.

Parameters
thicknessIf the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Returns
The created StiffenerLaminateLayer.
Exceptions
ArgumentException

◆ InsertLayer() [1/3]

StiffenerLaminateLayer hyperx.api.StiffenerLaminate.InsertLayer ( self,
item1 = None,
item2 = None,
item3 = None,
item4 = None,
item5 = None )
   Insert layer into stiffener laminate at `layerId` by section.
   `layerId` is 1 indexed.
Parameters
thicknessIf the material is orthotropic, don't provide a thickness.
Exceptions
ArgumentException
Parameters
<br>
   Insert layer into stiffener laminate at `layerId` by collection of sections.
   `layerId` is 1 indexed.
thicknessIf the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Exceptions
ArgumentException

◆ InsertLayer() [2/3]

StiffenerLaminateLayer hyperx.api.StiffenerLaminate.InsertLayer ( self,
tuple[types.StiffenerLaminateLayerLocation] locations,
int layerId,
str materialName,
float angle,
float thickness = None )

Insert layer into stiffener laminate at layerId by collection of sections.

layerId is 1 indexed.

Parameters
thicknessIf the material is orthotropic, don't provide a thickness. For all other material types, providing a thickness is required.
Exceptions
ArgumentException

◆ InsertLayer() [3/3]

StiffenerLaminateLayer hyperx.api.StiffenerLaminate.InsertLayer ( self,
types.StiffenerLaminateLayerLocation location,
int layerId,
str materialName,
float angle,
float thickness = None )

Insert layer into stiffener laminate at layerId by section.

layerId is 1 indexed.

Parameters
thicknessIf the material is orthotropic, don't provide a thickness.
Exceptions
ArgumentException

◆ RemoveLayer()

bool hyperx.api.StiffenerLaminate.RemoveLayer ( self,
int layerId )

Remove a layer by layerId.

layerId is 1 indexed.

Returns
False if the layerId does not correspond with a layer.

◆ Save()

None hyperx.api.StiffenerLaminate.Save ( self)

Save laminate to database.

Exceptions
InvalidOperationException

Reimplemented from hyperx.api.LaminateBase.

Property Documentation

◆ LaminateStiffenerProfile

hyperx.api.StiffenerLaminate.LaminateStiffenerProfile = property
static

◆ Layers

hyperx.api.StiffenerLaminate.Layers = property
static

Laminate layers.


The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py