hyperx.api.HoneycombCol Class Reference

Inheritance diagram for hyperx.api.HoneycombCol:

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

Protected Attributes
	_Entity = honeycombCol

Properties
	HoneycombColList = property

Constructor & Destructor Documentation

__init__()

hyperx.api.HoneycombCol.__init__	(		self,
		_api.HoneycombCol	honeycombCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.HoneycombCol.__iter__

(

self

)

__len__()

hyperx.api.HoneycombCol.__len__

(

self

)

Contains()

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

Check if an honeycomb material exists in this collection.

Copy()

Honeycomb hyperx.api.HoneycombCol.Copy	(		self,
		str	honeyToCopyName,
		str	newMaterialName = None,
		int	femId = None )

Copy a Honeycomb.

Parameters

femId

Defaults to 0 when there is no linked FEM.

Returns

The new copied Honeycomb.

Exceptions

ArgumentException

Throws on nonexistent Honeycomb material to copy or duplicate femId.

Count()

int hyperx.api.HoneycombCol.Count

(

self

)

Create()

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

Create a Honeycomb material.

Parameters

femId

Defaults to 0 when there is no linked FEM.

Returns

The created Honeycomb.

Exceptions

ArgumentException

Throws on duplicate femId.

Delete()

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

Delete a honeycomb material by name.

Returns false if the method the material is not found.

Get()

Honeycomb hyperx.api.HoneycombCol.Get	(		self,
		str	materialName )

Look up an Honeycomb material by its name.

Member Data Documentation

_Entity

hyperx.api.HoneycombCol._Entity = honeycombCol

protected

Property Documentation

HoneycombColList

hyperx.api.HoneycombCol.HoneycombColList = property

static

---

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

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