hyperx.api.LoadPropertyCol Class Reference

Inheritance diagram for hyperx.api.LoadPropertyCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.LoadPropertyCol loadPropertyCol)
	__iter__ (self)
	__len__ (self)
LoadProperty	CreateLoadProperty (self, types.LoadPropertyType loadPropertyType, types.FamilyCategory category, str name=None)
	Creates and returns a new hyperx.api.LoadProperty.
bool	DeleteLoadProperty (self, int id)
	Remove a hyperx.api.LoadProperty by id.
bool	DeleteLoadProperty (self, item1=None)
bool	DeleteLoadProperty (self, str name)
	Remove a hyperx.api.LoadProperty by name.
LoadProperty	Get (self, int id)
LoadProperty	Get (self, item1=None)
LoadProperty	Get (self, str name)
Public Member Functions inherited from hyperx.api.IdNameEntityCol
	__init__ (self, _api.IdNameEntityCol idNameEntityCol)
Public Member Functions inherited from hyperx.api.IdEntityCol
	__init__ (self, _api.IdEntityCol idEntityCol)
bool	Contains (self, int id)
int	Count (self)

Properties
	LoadPropertyColList = property
Properties inherited from hyperx.api.IdNameEntityCol
	Names = property
Properties inherited from hyperx.api.IdEntityCol
	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.LoadPropertyCol.__init__	(		self,
		_api.LoadPropertyCol	loadPropertyCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.LoadPropertyCol.__iter__

(

self

)

__len__()

hyperx.api.LoadPropertyCol.__len__

(

self

)

CreateLoadProperty()

LoadProperty hyperx.api.LoadPropertyCol.CreateLoadProperty	(		self,
		types.LoadPropertyType	loadPropertyType,
		types.FamilyCategory	category,
		str	name = None )

Creates and returns a new hyperx.api.LoadProperty.

HyperX will handle any naming conflicts, so it is important to use the returned hyperx.api.LoadProperty which may have a different name to what was provided.

Returns

The created hyperx.api.LoadProperty.

DeleteLoadProperty() [1/3]

bool hyperx.api.LoadPropertyCol.DeleteLoadProperty	(		self,
		int	id )

Remove a hyperx.api.LoadProperty by id.

Returns

True if successfully deleted.

DeleteLoadProperty() [2/3]

bool hyperx.api.LoadPropertyCol.DeleteLoadProperty	(		self,
			item1 = None )

   Remove a `hyperx.api.LoadProperty` by `id`.

Returns

True if successfully deleted.

   Remove a `hyperx.api.LoadProperty` by `name`.

True if successfully deleted.

DeleteLoadProperty() [3/3]

bool hyperx.api.LoadPropertyCol.DeleteLoadProperty	(		self,
		str	name )

Remove a hyperx.api.LoadProperty by name.

Returns

True if successfully deleted.

Get() [1/3]

LoadProperty hyperx.api.LoadPropertyCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

LoadProperty hyperx.api.LoadPropertyCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

LoadProperty hyperx.api.LoadPropertyCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

Property Documentation

LoadPropertyColList

hyperx.api.LoadPropertyCol.LoadPropertyColList = property

static

---

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

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