hyperx.api.FailureModeCol Class Reference

Inheritance diagram for hyperx.api.FailureModeCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.FailureModeCol failureModeCol)
	__iter__ (self)
	__len__ (self)
FailureMode	CreateFailureMode (self, int failureModeCategoryId, str name=None)
	Create a FailureMode by Id.
FailureMode	CreateFailureMode (self, item1=None, item2=None)
FailureMode	CreateFailureMode (self, str failureModeCategory, str name=None)
	Create a FailureMode by category.
bool	DeleteFailureMode (self, int id)
	Delete a hyperx.api.FailureMode.
bool	DeleteFailureMode (self, item1=None)
bool	DeleteFailureMode (self, str name)
	Delete a hyperx.api.FailureMode.
FailureMode	Get (self, int id)
FailureMode	Get (self, item1=None)
FailureMode	Get (self, str name)
Public Member Functions inherited from hyperx.api.IdNameEntityCol
	__getitem__ (self, int index)
	__init__ (self, _api.IdNameEntityCol idNameEntityCol)
	__iter__ (self)
	__len__ (self)
Public Member Functions inherited from hyperx.api.IdEntityCol
	__getitem__ (self, int index)
	__init__ (self, _api.IdEntityCol idEntityCol)
	__iter__ (self)
	__len__ (self)
bool	Contains (self, int id)
int	Count (self)

Properties
	FailureModeColList = property
Properties inherited from hyperx.api.IdNameEntityCol
	IdNameEntityColList = property
	Names = property
Properties inherited from hyperx.api.IdEntityCol
	IdEntityColList = property
	Ids = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdNameEntityCol
	_CollectedClass = T
Protected Attributes inherited from hyperx.api.IdEntityCol
	_Entity = idEntityCol

Constructor & Destructor Documentation

__init__()

hyperx.api.FailureModeCol.__init__	(		self,
		_api.FailureModeCol	failureModeCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.FailureModeCol.__iter__

(

self

)

__len__()

hyperx.api.FailureModeCol.__len__

(

self

)

CreateFailureMode() [1/3]

FailureMode hyperx.api.FailureModeCol.CreateFailureMode	(		self,
		int	failureModeCategoryId,
		str	name = None )

Create a FailureMode by Id.

Returns

The created FailureMode.

CreateFailureMode() [2/3]

FailureMode hyperx.api.FailureModeCol.CreateFailureMode	(		self,
			item1 = None,
			item2 = None )

   Create a FailureMode by Id.

Returns

The created FailureMode.

   Create a FailureMode by category.

The created FailureMode.

CreateFailureMode() [3/3]

FailureMode hyperx.api.FailureModeCol.CreateFailureMode	(		self,
		str	failureModeCategory,
		str	name = None )

Create a FailureMode by category.

Returns

The created FailureMode.

DeleteFailureMode() [1/3]

bool hyperx.api.FailureModeCol.DeleteFailureMode	(		self,
		int	id )

Delete a hyperx.api.FailureMode.

Returns

False if there is no failure mode in the collection with the given ID.

DeleteFailureMode() [2/3]

bool hyperx.api.FailureModeCol.DeleteFailureMode	(		self,
			item1 = None )

   Delete a `hyperx.api.FailureMode`.

Returns

False if there is no failure mode in the collection with the given name.

   Delete a `hyperx.api.FailureMode`.

False if there is no failure mode in the collection with the given ID.

DeleteFailureMode() [3/3]

bool hyperx.api.FailureModeCol.DeleteFailureMode	(		self,
		str	name )

Delete a hyperx.api.FailureMode.

Returns

False if there is no failure mode in the collection with the given name.

Get() [1/3]

FailureMode hyperx.api.FailureModeCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

FailureMode hyperx.api.FailureModeCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

FailureMode hyperx.api.FailureModeCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

Property Documentation

FailureModeColList

hyperx.api.FailureModeCol.FailureModeColList = property

static

---

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

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