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

Honeycomb material. More...

Public Member Functions

 __init__ (self, _api.Honeycomb honeycomb)
HoneycombTemperature AddTemperatureProperty (self, float temperature, float et, float ec, float gw, float gl, float ftu, float fcus, float fcub, float fcuc, float fsuw, float fsul, float sScfl=None, float sScfh=None, float k1=None, float k2=None, float k3=None, float c=None)
 Adds a temperature-dependent property for a material.
bool DeleteTemperatureProperty (self, float temperature)
 Deletes a temperature-dependent property for a material.
HoneycombTemperature GetTemperature (self, float lookupTemperature)
 Retrieve a Temperature from this material's temperature-dependent properties.
None Save (self)
 Save any changes to this honeycomb material to the database.

Protected Attributes

 _Entity = honeycomb

Properties

 CellSize = property
 Cell size.
 Cost = property
 CreationDate = property
 Date the material was created.
 Density = property
 Density.
 FemMaterialId = property
 Linked FEM Material ID.
 Form = property
 HoneycombTemperatureProperties = property
 List of this material's temperature-dependent properties.
 Id = property
 Manufacturer = property
 MaterialDescription = property
 MaterialFamilyName = property
 The material family for this material.
 ModificationDate = property
 Most recent modification date of the material.
 Name = property
 Name of this material.
 Specification = property
 UserNote = property
 Wet = property

Detailed Description

Honeycomb material.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.Honeycomb.__init__ ( self,
_api.Honeycomb honeycomb )

Member Function Documentation

◆ AddTemperatureProperty()

HoneycombTemperature hyperx.api.Honeycomb.AddTemperatureProperty ( self,
float temperature,
float et,
float ec,
float gw,
float gl,
float ftu,
float fcus,
float fcub,
float fcuc,
float fsuw,
float fsul,
float sScfl = None,
float sScfh = None,
float k1 = None,
float k2 = None,
float k3 = None,
float c = None )

Adds a temperature-dependent property for a material.

Returns
The newly created temperature-dependent property.

◆ DeleteTemperatureProperty()

bool hyperx.api.Honeycomb.DeleteTemperatureProperty ( self,
float temperature )

Deletes a temperature-dependent property for a material.

◆ GetTemperature()

HoneycombTemperature hyperx.api.Honeycomb.GetTemperature ( self,
float lookupTemperature )

Retrieve a Temperature from this material's temperature-dependent properties.

Allows a degree of tolerance to avoid issues with floating point numbers.

Parameters
LookupTemperatureTemperature to search for.
Returns
The temperature, if a matching one was found. Returns None if none exists.

◆ Save()

None hyperx.api.Honeycomb.Save ( self)

Save any changes to this honeycomb material to the database.

Member Data Documentation

◆ _Entity

hyperx.api.Honeycomb._Entity = honeycomb
protected

Property Documentation

◆ CellSize

hyperx.api.Honeycomb.CellSize = property
static

Cell size.

Eng: in / SI: mm

◆ Cost

hyperx.api.Honeycomb.Cost = property
static

◆ CreationDate

hyperx.api.Honeycomb.CreationDate = property
static

Date the material was created.

◆ Density

hyperx.api.Honeycomb.Density = property
static

Density.

Eng: lbm/in^3 / SI: kg/m^3

◆ FemMaterialId

hyperx.api.Honeycomb.FemMaterialId = property
static

Linked FEM Material ID.

Null if none exists.

◆ Form

hyperx.api.Honeycomb.Form = property
static

◆ HoneycombTemperatureProperties

hyperx.api.Honeycomb.HoneycombTemperatureProperties = property
static

List of this material's temperature-dependent properties.

◆ Id

hyperx.api.Honeycomb.Id = property
static

◆ Manufacturer

hyperx.api.Honeycomb.Manufacturer = property
static

◆ MaterialDescription

hyperx.api.Honeycomb.MaterialDescription = property
static

◆ MaterialFamilyName

hyperx.api.Honeycomb.MaterialFamilyName = property
static

The material family for this material.

When the material is saved, a new family will be created if none matching this name exists.

◆ ModificationDate

hyperx.api.Honeycomb.ModificationDate = property
static

Most recent modification date of the material.

◆ Name

hyperx.api.Honeycomb.Name = property
static

Name of this material.

◆ Specification

hyperx.api.Honeycomb.Specification = property
static

◆ UserNote

hyperx.api.Honeycomb.UserNote = property
static

◆ Wet

hyperx.api.Honeycomb.Wet = property
static

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