hyperx.api.StructureCol Class Reference

Inheritance diagram for hyperx.api.StructureCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.StructureCol structureCol)
	__iter__ (self)
	__len__ (self)
Structure	Create (self, str name=None)
	Attempt to create a new structure.
bool	DeleteStructure (self, int id)
bool	DeleteStructure (self, item1=None)
bool	DeleteStructure (self, str name)
bool	DeleteStructure (self, Structure structure)
Structure	Get (self, int id)
Structure	Get (self, item1=None)
Structure	Get (self, str name)
Public Member Functions inherited from hyperx.api.ZoneJointContainerCol
	__getitem__ (self, int index)
	__init__ (self, _api.ZoneJointContainerCol zoneJointContainerCol)
	__iter__ (self)
	__len__ (self)
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
	StructureColList = property
Properties inherited from hyperx.api.ZoneJointContainerCol
	ZoneJointContainerColList = 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.StructureCol.__init__	(		self,
		_api.StructureCol	structureCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.StructureCol.__iter__

(

self

)

__len__()

hyperx.api.StructureCol.__len__

(

self

)

Create()

Structure hyperx.api.StructureCol.Create	(		self,
		str	name = None )

Attempt to create a new structure.

If the specified name is already used, it will be deconflicted.

Parameters

name	The name of the structure to be created.

Reimplemented from hyperx.api.ZoneJointContainerCol.

DeleteStructure() [1/4]

bool hyperx.api.StructureCol.DeleteStructure	(		self,
		int	id )

DeleteStructure() [2/4]

bool hyperx.api.StructureCol.DeleteStructure	(		self,
			item1 = None )

DeleteStructure() [3/4]

bool hyperx.api.StructureCol.DeleteStructure	(		self,
		str	name )

DeleteStructure() [4/4]

bool hyperx.api.StructureCol.DeleteStructure	(		self,
		Structure	structure )

Get() [1/3]

Structure hyperx.api.StructureCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.ZoneJointContainerCol.

Get() [2/3]

Structure hyperx.api.StructureCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainerCol.

Get() [3/3]

Structure hyperx.api.StructureCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.ZoneJointContainerCol.

Property Documentation

StructureColList

hyperx.api.StructureCol.StructureColList = property

static

---

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

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