hyperx.api.SizingMaterialCol Class Reference

Inheritance diagram for hyperx.api.SizingMaterialCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.SizingMaterialCol sizingMaterialCol)
	__iter__ (self)
	__len__ (self)
bool	AddSizingMaterial (self, int materialId)
	Add a hyperx.api.SizingMaterial by materialId to the list of sizing material overrides for a hyperx.api.Zone.
bool	AddSizingMaterial (self, item1=None)
bool	AddSizingMaterial (self, str name)
	Add a hyperx.api.SizingMaterial by name to the list of sizing material overrides for a hyperx.api.Zone.
bool	Contains (self, int id)
bool	Contains (self, item1=None)
bool	Contains (self, str name)
	Check if the list of sizing materials contains a material by name.
SizingMaterial	Get (self, int id)
SizingMaterial	Get (self, item1=None)
SizingMaterial	Get (self, str name)
	Get a sizing material by name.
bool	RemoveSizingMaterial (self, int materialId)
	Remove a hyperx.api.SizingMaterial by materialId from the list of sizing material overrides for a hyperx.api.Zone.
bool	RemoveSizingMaterial (self, item1=None)
bool	RemoveSizingMaterial (self, str name)
	Remove a hyperx.api.SizingMaterial by name from the list of sizing material overrides for a hyperx.api.Zone.
Public Member Functions inherited from hyperx.api.IdEntityCol
	__getitem__ (self, int index)
	__init__ (self, _api.IdEntityCol idEntityCol)
	__iter__ (self)
	__len__ (self)
int	Count (self)

Protected Attributes
	_CollectedClass = SizingMaterial
Protected Attributes inherited from hyperx.api.IdEntityCol
	_Entity = idEntityCol

Properties
	SizingMaterialColList = property
Properties inherited from hyperx.api.IdEntityCol
	IdEntityColList = property
	Ids = property

Constructor & Destructor Documentation

__init__()

hyperx.api.SizingMaterialCol.__init__	(		self,
		_api.SizingMaterialCol	sizingMaterialCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.SizingMaterialCol.__iter__

(

self

)

__len__()

hyperx.api.SizingMaterialCol.__len__

(

self

)

AddSizingMaterial() [1/3]

bool hyperx.api.SizingMaterialCol.AddSizingMaterial	(		self,
		int	materialId )

Add a hyperx.api.SizingMaterial by materialId to the list of sizing material overrides for a hyperx.api.Zone.

Returns

False if the material does not exist or is already in the list of sizing materials.

AddSizingMaterial() [2/3]

bool hyperx.api.SizingMaterialCol.AddSizingMaterial	(		self,
			item1 = None )

   Add a `hyperx.api.SizingMaterial` by `materialId` to the list of sizing material overrides for a `hyperx.api.Zone`.

Returns

False if the material does not exist or is already in the list of sizing materials.

   Add a `hyperx.api.SizingMaterial` by `name` to the list of sizing material overrides for a `hyperx.api.Zone`.

False if the material does not exist or is already in the list of sizing materials.

AddSizingMaterial() [3/3]

bool hyperx.api.SizingMaterialCol.AddSizingMaterial	(		self,
		str	name )

Add a hyperx.api.SizingMaterial by name to the list of sizing material overrides for a hyperx.api.Zone.

Returns

False if the material does not exist or is already in the list of sizing materials.

Contains() [1/3]

bool hyperx.api.SizingMaterialCol.Contains	(		self,
		int	id )

Reimplemented from hyperx.api.IdEntityCol.

Contains() [2/3]

bool hyperx.api.SizingMaterialCol.Contains	(		self,
			item1 = None )

   Check if the list of sizing materials contains a material by name.

Returns

False if the material does not exist in the database or is not in the list of sizing materials.

Reimplemented from hyperx.api.IdEntityCol.

Contains() [3/3]

bool hyperx.api.SizingMaterialCol.Contains	(		self,
		str	name )

Check if the list of sizing materials contains a material by name.

Returns

False if the material does not exist in the database or is not in the list of sizing materials.

Reimplemented from hyperx.api.IdEntityCol.

Get() [1/3]

SizingMaterial hyperx.api.SizingMaterialCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdEntityCol.

Get() [2/3]

SizingMaterial hyperx.api.SizingMaterialCol.Get	(		self,
			item1 = None )

Get a sizing material by name.

Exceptions

ArgumentException

Throws if the material is not in the database or if the material is not in the list of sizing materials.

Reimplemented from hyperx.api.IdEntityCol.

Get() [3/3]

SizingMaterial hyperx.api.SizingMaterialCol.Get	(		self,
		str	name )

Get a sizing material by name.

Exceptions

ArgumentException

Throws if the material is not in the database or if the material is not in the list of sizing materials.

Reimplemented from hyperx.api.IdEntityCol.

RemoveSizingMaterial() [1/3]

bool hyperx.api.SizingMaterialCol.RemoveSizingMaterial	(		self,
		int	materialId )

Remove a hyperx.api.SizingMaterial by materialId from the list of sizing material overrides for a hyperx.api.Zone.

Returns

False if the material is not in the list of sizing materials.

RemoveSizingMaterial() [2/3]

bool hyperx.api.SizingMaterialCol.RemoveSizingMaterial	(		self,
			item1 = None )

   Remove a `hyperx.api.SizingMaterial` by `materialId` from the list of sizing material overrides for a `hyperx.api.Zone`.

Returns

False if the material is not in the list of sizing materials.

   Remove a `hyperx.api.SizingMaterial` by `name` from the list of sizing material overrides for a `hyperx.api.Zone`.

False if the material does not exist or is not in the list of sizing materials.

RemoveSizingMaterial() [3/3]

bool hyperx.api.SizingMaterialCol.RemoveSizingMaterial	(		self,
		str	name )

Remove a hyperx.api.SizingMaterial by name from the list of sizing material overrides for a hyperx.api.Zone.

Returns

False if the material does not exist or is not in the list of sizing materials.

Member Data Documentation

_CollectedClass

hyperx.api.SizingMaterialCol._CollectedClass = SizingMaterial

protected

Property Documentation

SizingMaterialColList

hyperx.api.SizingMaterialCol.SizingMaterialColList = property

static

---

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

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