hyperx.api.IsotropicCol Class Reference

Inheritance diagram for hyperx.api.IsotropicCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.IsotropicCol isotropicCol)
	__iter__ (self)
	__len__ (self)
bool	Contains (self, str materialName)
	Check if an isotropic material exists in this collection.
Isotropic	Copy (self, str isoToCopyName, str newMaterialName=None, int femId=None)
	Copy an Isotropic material.
int	Count (self)
Isotropic	Create (self, str materialFamilyName, float density, str newMaterialName=None, int femId=None)
	Create an Isotropic material.
bool	Delete (self, str materialName)
	Delete an isotropic material by name.
Isotropic	Get (self, str materialName)
	Look up an Isotropic material by its name.

Protected Attributes
	_Entity = isotropicCol

Properties
	IsotropicColList = property

Constructor & Destructor Documentation

__init__()

hyperx.api.IsotropicCol.__init__	(		self,
		_api.IsotropicCol	isotropicCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.IsotropicCol.__iter__

(

self

)

__len__()

hyperx.api.IsotropicCol.__len__

(

self

)

Contains()

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

Check if an isotropic material exists in this collection.

Copy()

Isotropic hyperx.api.IsotropicCol.Copy	(		self,
		str	isoToCopyName,
		str	newMaterialName = None,
		int	femId = None )

Copy an Isotropic material.

Parameters

femId

Defaults to 0 when there is no linked FEM.

Returns

The new copied Isotropic.

Exceptions

ArgumentException

Throws on nonexistent Isotropic material to copy or duplicate femId.

Count()

int hyperx.api.IsotropicCol.Count

(

self

)

Create()

Isotropic hyperx.api.IsotropicCol.Create	(		self,
		str	materialFamilyName,
		float	density,
		str	newMaterialName = None,
		int	femId = None )

Create an Isotropic material.

Parameters

femId

Defaults to 0 when there is no linked FEM.

Returns

The created Isotropic.

Exceptions

ArgumentException

Throws on duplicate femId.

Delete()

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

Delete an isotropic material by name.

Returns false if the method the material is not found.

Get()

Isotropic hyperx.api.IsotropicCol.Get	(		self,
		str	materialName )

Look up an Isotropic material by its name.

Member Data Documentation

_Entity

hyperx.api.IsotropicCol._Entity = isotropicCol

protected

Property Documentation

IsotropicColList

hyperx.api.IsotropicCol.IsotropicColList = property

static

---

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

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