HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.ZoneCol Class Reference
Inheritance diagram for hyperx.api.ZoneCol:
hyperx.api.EntityWithAssignablePropertiesCol hyperx.api.IdNameEntityCol hyperx.api.IdEntityCol

Public Member Functions

 __getitem__ (self, int index)
 __init__ (self, _api.ZoneCol zoneCol)
 __iter__ (self)
 __len__ (self)
Zone Get (self, int id)
Zone Get (self, item1=None)
Zone Get (self, str name)
BeamBulkUpdater GetBeamBulkUpdater (self)
 Get a hyperx.api.BulkUpdaterBase to bulk update all hyperx.api.Beam entities in this collection.
ZoneBulkUpdater GetBulkUpdater (self)
 Get a hyperx.api.BulkUpdaterBase to bulk update all hyperx.api.Zone entities in this collection.
PanelBulkUpdater GetPanelBulkUpdater (self)
 Get a hyperx.api.BulkUpdaterBase to bulk update all hyperx.api.Panel entities in this collection.
Public Member Functions inherited from hyperx.api.EntityWithAssignablePropertiesCol
 __init__ (self, _api.EntityWithAssignablePropertiesCol entityWithAssignablePropertiesCol)
PropertyAssignmentStatus AssignPropertyToAll (self, AssignableProperty property)
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

 ZoneColList = 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.ZoneCol.__init__ ( self,
_api.ZoneCol zoneCol )

Member Function Documentation

◆ __getitem__()

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

◆ __iter__()

hyperx.api.ZoneCol.__iter__ ( self)

◆ __len__()

hyperx.api.ZoneCol.__len__ ( self)

◆ Get() [1/3]

Zone hyperx.api.ZoneCol.Get ( self,
int id )

◆ Get() [2/3]

Zone hyperx.api.ZoneCol.Get ( self,
item1 = None )

◆ Get() [3/3]

Zone hyperx.api.ZoneCol.Get ( self,
str name )

◆ GetBeamBulkUpdater()

BeamBulkUpdater hyperx.api.ZoneCol.GetBeamBulkUpdater ( self)

Get a hyperx.api.BulkUpdaterBase to bulk update all hyperx.api.Beam entities in this collection.

Also available via the BeamBulkUpdater.GetBulkUpdater() static method.

Returns
Returns a hyperx.api.BeamBulkUpdater to bulk update all hyperx.api.Beam entities in this collection.

◆ GetBulkUpdater()

ZoneBulkUpdater hyperx.api.ZoneCol.GetBulkUpdater ( self)

Get a hyperx.api.BulkUpdaterBase to bulk update all hyperx.api.Zone entities in this collection.

Also available via the ZoneBulkUpdater.GetBulkUpdater() static method.

Returns
Returns a hyperx.api.ZoneBulkUpdater to bulk update all hyperx.api.Zone entities in this collection.

◆ GetPanelBulkUpdater()

PanelBulkUpdater hyperx.api.ZoneCol.GetPanelBulkUpdater ( self)

Get a hyperx.api.BulkUpdaterBase to bulk update all hyperx.api.Panel entities in this collection.

Also available via the PanelBulkUpdater.GetBulkUpdater() static method.

Returns
Returns a hyperx.api.PanelBulkUpdater to bulk update all hyperx.api.Panel entities in this collection.

Property Documentation

◆ ZoneColList

hyperx.api.ZoneCol.ZoneColList = property
static

The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py