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)
	Returns true if the structure was deleted from the collection.
bool	DeleteStructure (self, item1=None)
bool	DeleteStructure (self, str name)
	Returns true if the structure was deleted from the collection.
bool	DeleteStructure (self, Structure structure)
	Returns true if the structure was deleted from the collection.
Structure	Get (self, int id)
Structure	Get (self, item1=None)
Structure	Get (self, str name)
Public Member Functions inherited from hyperx.api.ZoneJointContainerCol
	__init__ (self, _api.ZoneJointContainerCol zoneJointContainerCol)
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
	Folders = property
	StructureColList = 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.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.

Returns

Return the new Structure

Reimplemented from hyperx.api.ZoneJointContainerCol.

DeleteStructure() [1/4]

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

Returns true if the structure was deleted from the collection.

Returns false if the structure could not be found or if there are run sets in the project.

DeleteStructure() [2/4]

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

Returns true if the structure was deleted from the collection. Returns false if the structure could not be found or if there are run sets in the project.

Returns true if the structure was deleted from the collection. Returns false if the structure could not be found or if there are run sets in the project.

Returns true if the structure was deleted from the collection. Returns false if the structure could not be found or if there are run sets in the project.

DeleteStructure() [3/4]

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

Returns true if the structure was deleted from the collection.

Returns false if the structure could not be found or if there are run sets in the project.

DeleteStructure() [4/4]

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

Returns true if the structure was deleted from the collection.

Returns false if the structure could not be found or if there are run sets in the project.

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

Folders

hyperx.api.StructureCol.Folders = property

static

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