hyperx.api.OrthotropicCol Class Reference

Inheritance diagram for hyperx.api.OrthotropicCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.OrthotropicCol orthotropicCol)
	__iter__ (self)
	__len__ (self)
bool	Contains (self, str materialName)
	Check if an orthotropic material exists in this collection.
Orthotropic	Copy (self, str orthoToCopyName, str newMaterialName=None, int femId=None)
	Copy an Orthotropic material.
int	Count (self)
Orthotropic	Create (self, str materialFamilyName, float thickness, float density, str newMaterialName=None, int femId=None)
	Create an Orthotropic material.
Orthotropic	CreateEffectiveLaminate (self, int|None tapeMaterialId, int|None fabricMaterialId, str namePrefix, int tape0, int tape45, int tape90, int fabric0, int fabric45, int fabric90)
	Create an effective laminate with the specified ply angle percentages.
bool	Delete (self, str materialName)
	Delete an orthotropic material by name.
list[Orthotropic]	GenerateEffectiveLaminates (self, int|None tapeMaterialId, int|None fabricMaterialId, str namePrefix, int minTape0=10, int maxTape0=50, int stepTape0=10, int minTape45=20, int maxTape45=60, int stepTape45=20, int minTape90=10, int maxTape90=50, int stepTape90=10, int minFabric0=10, int maxFabric0=50, int stepFabric0=10, int minFabric45=20, int maxFabric45=60, int stepFabric45=10, int minFabric90=10, int maxFabric90=50, int stepFabric90=10)
	Generate effective laminates with the specified ply angle constraints.
Orthotropic	Get (self, str materialName)
	Look up an Orthotropic material by its name.

Protected Attributes
	_Entity = orthotropicCol

Properties
	OrthotropicColList = property

Constructor & Destructor Documentation

__init__()

hyperx.api.OrthotropicCol.__init__	(		self,
		_api.OrthotropicCol	orthotropicCol )

Member Function Documentation

__getitem__()

hyperx.api.OrthotropicCol.__getitem__	(		self,
		int	index )

__iter__()

hyperx.api.OrthotropicCol.__iter__

(

self

)

__len__()

hyperx.api.OrthotropicCol.__len__

(

self

)

Contains()

bool hyperx.api.OrthotropicCol.Contains	(		self,
		str	materialName )

Check if an orthotropic material exists in this collection.

Copy()

Orthotropic hyperx.api.OrthotropicCol.Copy	(		self,
		str	orthoToCopyName,
		str	newMaterialName = None,
		int	femId = None )

Copy an Orthotropic material.

Parameters

femId

Defaults to 0 when there is no linked FEM.

Returns

The new copied Orthotropic.

Exceptions

ArgumentException

Throws on nonexistent Orthotropic material to copy or duplicate femId.

Count()

int hyperx.api.OrthotropicCol.Count

(

self

)

Create()

Orthotropic hyperx.api.OrthotropicCol.Create	(		self,
		str	materialFamilyName,
		float	thickness,
		float	density,
		str	newMaterialName = None,
		int	femId = None )

Create an Orthotropic material.

Parameters

femId

Defaults to 0 when there is no linked FEM.

Returns

The created Orthotropic.

Exceptions

ArgumentException

Throws on duplicate femId.

CreateEffectiveLaminate()

Orthotropic hyperx.api.OrthotropicCol.CreateEffectiveLaminate	(		self,
		int | None	tapeMaterialId,
		int | None	fabricMaterialId,
		str	namePrefix,
		int	tape0,
		int	tape45,
		int	tape90,
		int	fabric0,
		int	fabric45,
		int	fabric90 )

Create an effective laminate with the specified ply angle percentages.

Exceptions

ArgumentException

Delete()

bool hyperx.api.OrthotropicCol.Delete	(		self,
		str	materialName )

Delete an orthotropic material by name.

Returns false if the method the material is not found.

GenerateEffectiveLaminates()

list[Orthotropic] hyperx.api.OrthotropicCol.GenerateEffectiveLaminates	(		self,
		int | None	tapeMaterialId,
		int | None	fabricMaterialId,
		str	namePrefix,
		int	minTape0 = 10,
		int	maxTape0 = 50,
		int	stepTape0 = 10,
		int	minTape45 = 20,
		int	maxTape45 = 60,
		int	stepTape45 = 20,
		int	minTape90 = 10,
		int	maxTape90 = 50,
		int	stepTape90 = 10,
		int	minFabric0 = 10,
		int	maxFabric0 = 50,
		int	stepFabric0 = 10,
		int	minFabric45 = 20,
		int	maxFabric45 = 60,
		int	stepFabric45 = 10,
		int	minFabric90 = 10,
		int	maxFabric90 = 50,
		int	stepFabric90 = 10 )

Generate effective laminates with the specified ply angle constraints.

Exceptions

ArgumentException

Get()

Orthotropic hyperx.api.OrthotropicCol.Get	(		self,
		str	materialName )

Look up an Orthotropic material by its name.

Member Data Documentation

_Entity

hyperx.api.OrthotropicCol._Entity = orthotropicCol

protected

Property Documentation

OrthotropicColList

hyperx.api.OrthotropicCol.OrthotropicColList = property

static

---

The documentation for this class was generated from the following file:

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py