hyperx.api.Orthotropic Class Reference

Orthotropic material. More...

Public Member Functions
	__init__ (self, _api.Orthotropic orthotropic)
OrthotropicEquationCorrectionFactor	AddEquationCorrectionFactor (self, types.CorrectionProperty propertyId, types.CorrectionId correctionId, types.CorrectionEquation equationId)
	Adds an equation-based correction factor for this material.
OrthotropicLaminateAllowable	AddLaminateAllowable (self, types.AllowablePropertyName property, types.AllowableMethodName method)
	Adds a laminate allowable to this material.
OrthotropicTemperature	AddTemperatureProperty (self, float temperature, float et1, float et2, float vt12, float ec1, float ec2, float vc12, float g12, float ftu1, float ftu2, float fcu1, float fcu2, float fsu12, float alpha1, float alpha2, float etu1, float etu2, float ecu1, float ecu2, float esu12)
	Adds a temperature-dependent property for a material.
bool	DeleteTemperatureProperty (self, float temperature)
	Deletes a temperature-dependent property for a material.
OrthotropicEquationCorrectionFactor	GetEquationCorrectionFactor (self, types.CorrectionProperty property, types.CorrectionId correction)
	Retrieve a Correction Factor from this material's correction factors.
OrthotropicLaminateAllowable	GetLaminateAllowable (self, types.AllowablePropertyName lookupAllowableProperty)
	Retrieve a Laminate allowable from this material's laminate allowables.
OrthotropicTabularCorrectionFactor	GetTabularCorrectionFactor (self, types.CorrectionProperty property, types.CorrectionId correction)
	Retrieve a Correction Factor from this material's correction factors.
OrthotropicTemperature	GetTemperature (self, float lookupTemperature)
	Retrieve a Temperature from this material's temperature-dependent properties.
bool	HasLaminateAllowable (self, types.AllowablePropertyName property)
	Returns true if this material has a specified laminate allowable property.
bool	IsEffectiveLaminate (self)
	Returns true if this material is an effective laminate.
None	Save (self)
	Save any changes to this orthotropic material to the database.

Protected Attributes
	_Entity = orthotropic

Static Protected Attributes
	_OrthotropicEffectiveLaminate

Properties
	Basis = property
	BendingCorrectionFactor = property
	BucklingStiffnessKnockdown = property
	Cost = property
	CreationDate = property
	Date the material was created.
	Density = property
	Density.
	FemMaterialId = property
	Linked FEM Material ID.
	FiberVolume = property
	Fiber Volume.
	Form = property
	GlassTransition = property
	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.
	OrthotropicEffectiveLaminate = property
	Contains Effective Laminate data if this material is an effective laminate, otherwise None.
	OrthotropicEquationCorrectionFactors = property
	Dictionary of this material's equation-based correction factors.
	OrthotropicLaminateAllowables = property
	List of this material's laminate allowable properties.
	OrthotropicTabularCorrectionFactors = property
	Dictionary of this material's tabular correction factors.
	OrthotropicTemperatureProperties = property
	List of this material's temperature-dependent properties.
	Processes = property
	Specification = property
	Thickness = property
	Thickness.
	UserNote = property
	Wet = property

Detailed Description

Orthotropic material.

Constructor & Destructor Documentation

__init__()

hyperx.api.Orthotropic.__init__	(		self,
		_api.Orthotropic	orthotropic )

Member Function Documentation

AddEquationCorrectionFactor()

OrthotropicEquationCorrectionFactor hyperx.api.Orthotropic.AddEquationCorrectionFactor	(		self,
		types.CorrectionProperty	propertyId,
		types.CorrectionId	correctionId,
		types.CorrectionEquation	equationId )

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.

AddLaminateAllowable()

OrthotropicLaminateAllowable hyperx.api.Orthotropic.AddLaminateAllowable	(		self,
		types.AllowablePropertyName	property,
		types.AllowableMethodName	method )

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.

AddTemperatureProperty()

OrthotropicTemperature hyperx.api.Orthotropic.AddTemperatureProperty	(		self,
		float	temperature,
		float	et1,
		float	et2,
		float	vt12,
		float	ec1,
		float	ec2,
		float	vc12,
		float	g12,
		float	ftu1,
		float	ftu2,
		float	fcu1,
		float	fcu2,
		float	fsu12,
		float	alpha1,
		float	alpha2,
		float	etu1,
		float	etu2,
		float	ecu1,
		float	ecu2,
		float	esu12 )

Adds a temperature-dependent property for a material.

Returns

The newly created temperature-dependent property.

DeleteTemperatureProperty()

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

Deletes a temperature-dependent property for a material.

GetEquationCorrectionFactor()

OrthotropicEquationCorrectionFactor hyperx.api.Orthotropic.GetEquationCorrectionFactor	(		self,
		types.CorrectionProperty	property,
		types.CorrectionId	correction )

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 None if none exists.

GetLaminateAllowable()

OrthotropicLaminateAllowable hyperx.api.Orthotropic.GetLaminateAllowable	(		self,
		types.AllowablePropertyName	lookupAllowableProperty )

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 None if none exists.

GetTabularCorrectionFactor()

OrthotropicTabularCorrectionFactor hyperx.api.Orthotropic.GetTabularCorrectionFactor	(		self,
		types.CorrectionProperty	property,
		types.CorrectionId	correction )

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 None if none exists.

GetTemperature()

OrthotropicTemperature hyperx.api.Orthotropic.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

LookupTemperature

Temperature to search for.

Returns

The temperature, if a matching one was found. Returns None if none exists.

HasLaminateAllowable()

bool hyperx.api.Orthotropic.HasLaminateAllowable	(		self,
		types.AllowablePropertyName	property )

Returns true if this material has a specified laminate allowable property.

IsEffectiveLaminate()

bool hyperx.api.Orthotropic.IsEffectiveLaminate

(

self

)

Returns true if this material is an effective laminate.

Save()

None hyperx.api.Orthotropic.Save

(

self

)

Save any changes to this orthotropic material to the database.

Member Data Documentation

_Entity

hyperx.api.Orthotropic._Entity = orthotropic

protected

_OrthotropicEffectiveLaminate

hyperx.api.Orthotropic._OrthotropicEffectiveLaminate

staticprotected

Property Documentation

Basis

hyperx.api.Orthotropic.Basis = property

static

BendingCorrectionFactor

hyperx.api.Orthotropic.BendingCorrectionFactor = property

static

BucklingStiffnessKnockdown

hyperx.api.Orthotropic.BucklingStiffnessKnockdown = property

static

Cost

hyperx.api.Orthotropic.Cost = property

static

CreationDate

hyperx.api.Orthotropic.CreationDate = property

static

Date the material was created.

Density

hyperx.api.Orthotropic.Density = property

static

Density.

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

FemMaterialId

hyperx.api.Orthotropic.FemMaterialId = property

static

Linked FEM Material ID.

Null if none exists.

FiberVolume

hyperx.api.Orthotropic.FiberVolume = property

static

Fiber Volume.

Expressed as a percentage.

Form

hyperx.api.Orthotropic.Form = property

static

GlassTransition

hyperx.api.Orthotropic.GlassTransition = property

static

Id

hyperx.api.Orthotropic.Id = property

static

Manufacturer

hyperx.api.Orthotropic.Manufacturer = property

static

MaterialDescription

hyperx.api.Orthotropic.MaterialDescription = property

static

MaterialFamilyName

hyperx.api.Orthotropic.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.Orthotropic.ModificationDate = property

static

Most recent modification date of the material.

Name

hyperx.api.Orthotropic.Name = property

static

Name of this material.

OrthotropicEffectiveLaminate

hyperx.api.Orthotropic.OrthotropicEffectiveLaminate = property

static

Contains Effective Laminate data if this material is an effective laminate, otherwise None.

OrthotropicEquationCorrectionFactors

hyperx.api.Orthotropic.OrthotropicEquationCorrectionFactors = property

static

Dictionary of this material's equation-based correction factors.

OrthotropicLaminateAllowables

hyperx.api.Orthotropic.OrthotropicLaminateAllowables = property

static

List of this material's laminate allowable properties.

OrthotropicTabularCorrectionFactors

hyperx.api.Orthotropic.OrthotropicTabularCorrectionFactors = property

static

Dictionary of this material's tabular correction factors.

OrthotropicTemperatureProperties

hyperx.api.Orthotropic.OrthotropicTemperatureProperties = property

static

List of this material's temperature-dependent properties.

Processes

hyperx.api.Orthotropic.Processes = property

static

Specification

hyperx.api.Orthotropic.Specification = property

static

Thickness

hyperx.api.Orthotropic.Thickness = property

static

Thickness.

Eng: in / SI: mm

UserNote

hyperx.api.Orthotropic.UserNote = property

static

Wet

hyperx.api.Orthotropic.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