hyperx.api.FoamCol Class Reference

Inheritance diagram for hyperx.api.FoamCol:

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

Protected Attributes
	_Entity = foamCol

Properties
	FoamColList = property

Constructor & Destructor Documentation

__init__()

hyperx.api.FoamCol.__init__	(		self,
		_api.FoamCol	foamCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.FoamCol.__iter__

(

self

)

__len__()

hyperx.api.FoamCol.__len__

(

self

)

Contains()

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

Check if an foam material exists in this collection.

Copy()

Foam hyperx.api.FoamCol.Copy	(		self,
		str	fmToCopyName,
		str	newMaterialName = None,
		int	femId = None )

Count()

int hyperx.api.FoamCol.Count

(

self

)

Create()

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

Delete()

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

Delete a foam material by name.

Returns false if the method the material is not found.

Get()

Foam hyperx.api.FoamCol.Get	(		self,
		str	materialName )

Look up an Foam material by its name.

Member Data Documentation

_Entity

hyperx.api.FoamCol._Entity = foamCol

protected

Property Documentation

FoamColList

hyperx.api.FoamCol.FoamColList = property

static

---

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

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