hyperx.api.AnalysisProperty Class Reference

Inheritance diagram for hyperx.api.AnalysisProperty:

Public Member Functions
	__init__ (self, _api.AnalysisProperty analysisProperty)
None	AddFailureMode (self, FailureMode failureMode)
	Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.
None	AddFailureMode (self, int id)
	Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.
None	AddFailureMode (self, item1=None)
None	AddFailureMode (self, str name)
	Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.
None	AddFailureMode (self, tuple[FailureMode] failureModes)
	Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.
None	AddFailureMode (self, tuple[int] ids)
	Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.
None	AddFailureMode (self, tuple[str] names)
	Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.
PropertyAssignmentStatus	AssignTo (self, tuple[int] entityIds)
	Assigns the hyperx.api.AnalysisProperty to a collection of entity Ids where the entity type is determined by the hyperx.api.AssignablePropertyWithFamilyCategory.FamilyCategory property.
AnalysisProperty	Copy (self)
	Creates and returns a copy of this hyperx.api.AnalysisProperty.
None	RemoveFailureMode (self, FailureMode failureMode)
	Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.
None	RemoveFailureMode (self, int id)
	Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.
None	RemoveFailureMode (self, item1=None)
None	RemoveFailureMode (self, str name)
	Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.
None	RemoveFailureMode (self, tuple[FailureMode] failureModes)
	Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.
None	RemoveFailureMode (self, tuple[int] ids)
	Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.
None	RemoveFailureMode (self, tuple[str] names)
	Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.
Public Member Functions inherited from hyperx.api.AssignablePropertyWithFamilyCategory
	__init__ (self, _api.AssignablePropertyWithFamilyCategory assignablePropertyWithFamilyCategory)
Public Member Functions inherited from hyperx.api.AssignableProperty
	__init__ (self, _api.AssignableProperty assignableProperty)
Public Member Functions inherited from hyperx.api.IdNameEntity
	__init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	FailureModes = property
Properties inherited from hyperx.api.AssignablePropertyWithFamilyCategory
	FamilyCategory = property
Properties inherited from hyperx.api.IdNameEntity
	Name = property
Properties inherited from hyperx.api.IdEntity
	Id = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdEntity
	_Entity = idEntity

Constructor & Destructor Documentation

__init__()

hyperx.api.AnalysisProperty.__init__	(		self,
		_api.AnalysisProperty	analysisProperty )

Member Function Documentation

AddFailureMode() [1/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
		FailureMode	failureMode )

Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

AddFailureMode() [2/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
		int	id )

Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

AddFailureMode() [3/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
			item1 = None )

Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Exceptions

ArgumentException

When `name` is not present in the database (`hyperx.api.Application.FailureModes`).

Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Exceptions

ArgumentException

When `names` contains a failure mode name that is not present in the database (`hyperx.api.Application.FailureModes`).

Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

AddFailureMode() [4/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
		str	name )

Add a failure mode to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Exceptions

ArgumentException

When `name` is not present in the database (`hyperx.api.Application.FailureModes`).

AddFailureMode() [5/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
		tuple[FailureMode]	failureModes )

Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

AddFailureMode() [6/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
		tuple[int]	ids )

Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

AddFailureMode() [7/7]

None hyperx.api.AnalysisProperty.AddFailureMode	(		self,
		tuple[str]	names )

Adds a collection of failure modes to the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Exceptions

ArgumentException

When `names` contains a failure mode name that is not present in the database (`hyperx.api.Application.FailureModes`).

AssignTo()

PropertyAssignmentStatus hyperx.api.AnalysisProperty.AssignTo	(		self,
		tuple[int]	entityIds )

Assigns the hyperx.api.AnalysisProperty to a collection of entity Ids where the entity type is determined by the hyperx.api.AssignablePropertyWithFamilyCategory.FamilyCategory property.

Returns

hyperx.api.PropertyAssignmentStatus.Success if the operation executes successfully.

Copy()

AnalysisProperty hyperx.api.AnalysisProperty.Copy

(

self

)

Creates and returns a copy of this hyperx.api.AnalysisProperty.

Returns

The new copied hyperx.api.AnalysisProperty.

RemoveFailureMode() [1/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
		FailureMode	failureMode )

Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

RemoveFailureMode() [2/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
		int	id )

Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

RemoveFailureMode() [3/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
			item1 = None )

Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

RemoveFailureMode() [4/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
		str	name )

Remove a failure mode from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

RemoveFailureMode() [5/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
		tuple[FailureMode]	failureModes )

Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode.

RemoveFailureMode() [6/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
		tuple[int]	ids )

Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Id.

RemoveFailureMode() [7/7]

None hyperx.api.AnalysisProperty.RemoveFailureMode	(		self,
		tuple[str]	names )

Remove a collection of failure modes from the hyperx.api.AnalysisProperty by the hyperx.api.FailureMode Name.

Property Documentation

FailureModes

hyperx.api.AnalysisProperty.FailureModes = property

static

---

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

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