hyperx.api.DesignPropertyCol Class Reference

Inheritance diagram for hyperx.api.DesignPropertyCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.DesignPropertyCol designPropertyCol)
	__iter__ (self)
	__len__ (self)
DesignProperty	CreateDesignProperty (self, types.FamilyConceptUID familyConcept, types.MaterialMode materialMode=types.MaterialMode.Any, str name=None, types.DiscreteTechnique discreteTechnique=None)
	Creates and returns a hyperx.api.DesignProperty.
bool	DeleteDesignProperty (self, int id)
	Delete a hyperx.api.DesignProperty.
bool	DeleteDesignProperty (self, item1=None)
bool	DeleteDesignProperty (self, str name)
	Delete a hyperx.api.DesignProperty.
DesignProperty	Get (self, int id)
DesignProperty	Get (self, item1=None)
DesignProperty	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
	DesignPropertyColList = 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.DesignPropertyCol.__init__	(		self,
		_api.DesignPropertyCol	designPropertyCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.DesignPropertyCol.__iter__

(

self

)

__len__()

hyperx.api.DesignPropertyCol.__len__

(

self

)

CreateDesignProperty()

DesignProperty hyperx.api.DesignPropertyCol.CreateDesignProperty	(		self,
		types.FamilyConceptUID	familyConcept,
		types.MaterialMode	materialMode = types.MaterialMode.Any,
		str	name = None,
		types.DiscreteTechnique	discreteTechnique = None )

Creates and returns a hyperx.api.DesignProperty.

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

Returns

The created hyperx.api.DesignProperty.

DeleteDesignProperty() [1/3]

bool hyperx.api.DesignPropertyCol.DeleteDesignProperty	(		self,
		int	id )

Delete a hyperx.api.DesignProperty.

Returns

False if there is no design property in the collection with the given ID.

DeleteDesignProperty() [2/3]

bool hyperx.api.DesignPropertyCol.DeleteDesignProperty	(		self,
			item1 = None )

   Delete a `hyperx.api.DesignProperty`.

Returns

False if there is no design property in the collection with the given name.

   Delete a `hyperx.api.DesignProperty`.

False if there is no design property in the collection with the given ID.

DeleteDesignProperty() [3/3]

bool hyperx.api.DesignPropertyCol.DeleteDesignProperty	(		self,
		str	name )

Delete a hyperx.api.DesignProperty.

Returns

False if there is no design property in the collection with the given name.

Get() [1/3]

DesignProperty hyperx.api.DesignPropertyCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

DesignProperty hyperx.api.DesignPropertyCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

DesignProperty hyperx.api.DesignPropertyCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

Property Documentation

DesignPropertyColList

hyperx.api.DesignPropertyCol.DesignPropertyColList = property

static

---

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

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