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

Public Member Functions

 __getitem__ (self, int index)
 __init__ (self, _api.PlyCol plyCol)
 __iter__ (self)
 __len__ (self)
CollectionModificationStatus Delete (self, int id)
None DeleteAll (self)
 Delete all plies in the collection.
None ExportToCSV (self, str filepath)
 This feature is in development and may not work as expected.
Ply Get (self, int id)
Ply Get (self, item1=None)
Ply Get (self, str name)
None ImportCSV (self, str filepath)
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

 PlyColList = 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.PlyCol.__init__ ( self,
_api.PlyCol plyCol )

Member Function Documentation

◆ __getitem__()

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

◆ __iter__()

hyperx.api.PlyCol.__iter__ ( self)

◆ __len__()

hyperx.api.PlyCol.__len__ ( self)

◆ Delete()

CollectionModificationStatus hyperx.api.PlyCol.Delete ( self,
int id )

◆ DeleteAll()

None hyperx.api.PlyCol.DeleteAll ( self)

Delete all plies in the collection.

◆ ExportToCSV()

None hyperx.api.PlyCol.ExportToCSV ( self,
str filepath )

This feature is in development and may not work as expected.

Use at your own risk!

◆ Get() [1/3]

Ply hyperx.api.PlyCol.Get ( self,
int id )

Reimplemented from hyperx.api.IdNameEntityCol.

◆ Get() [2/3]

Ply hyperx.api.PlyCol.Get ( self,
item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

◆ Get() [3/3]

Ply hyperx.api.PlyCol.Get ( self,
str name )

Reimplemented from hyperx.api.IdNameEntityCol.

◆ ImportCSV()

None hyperx.api.PlyCol.ImportCSV ( self,
str filepath )

Property Documentation

◆ PlyColList

hyperx.api.PlyCol.PlyColList = property
static

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