hyperx.api.DiscreteFieldCol Class Reference

Inheritance diagram for hyperx.api.DiscreteFieldCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.DiscreteFieldCol discreteFieldCol)
	__iter__ (self)
	__len__ (self)
DiscreteField	Create (self, types.DiscreteFieldPhysicalEntityType entityType, types.DiscreteFieldDataType dataType, str name=None)
	Create a new DiscreteField.
list[DiscreteField]	CreateByPointMapToElements (self, tuple[int] elementIds, tuple[int] discreteFieldIds, str suffix=None, float tolerance=None)
	Create Discrete Fields by mapping existing Point-based Discrete Fields to new element-based Discrete Fields.
list[DiscreteField]	CreateFromVCP (self, str filepath)
	Create a list of DiscreteFields from VCP.
CollectionModificationStatus	Delete (self, int id)
	In the event of getting a CollectionModificationStatus.EntityMissingRemovalFailure, note that the discrete field is associated with a ply, and therefore cannot be deleted.
DiscreteField	Get (self, int id)
DiscreteField	Get (self, item1=None)
DiscreteField	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
	DiscreteFieldColList = 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.DiscreteFieldCol.__init__	(		self,
		_api.DiscreteFieldCol	discreteFieldCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.DiscreteFieldCol.__iter__

(

self

)

__len__()

hyperx.api.DiscreteFieldCol.__len__

(

self

)

Create()

DiscreteField hyperx.api.DiscreteFieldCol.Create	(		self,
		types.DiscreteFieldPhysicalEntityType	entityType,
		types.DiscreteFieldDataType	dataType,
		str	name = None )

Create a new DiscreteField.

Returns

The created DiscreteField.

CreateByPointMapToElements()

list[DiscreteField] hyperx.api.DiscreteFieldCol.CreateByPointMapToElements	(		self,
		tuple[int]	elementIds,
		tuple[int]	discreteFieldIds,
		str	suffix = None,
		float	tolerance = None )

Create Discrete Fields by mapping existing Point-based Discrete Fields to new element-based Discrete Fields.

Returns

The list of created DiscreteFields.

Exceptions

InvalidOperationException

CreateFromVCP()

list[DiscreteField] hyperx.api.DiscreteFieldCol.CreateFromVCP	(		self,
		str	filepath )

Create a list of DiscreteFields from VCP.

Returns

The list of created DiscreteFields.

Exceptions

InvalidOperationException

Delete()

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

In the event of getting a CollectionModificationStatus.EntityMissingRemovalFailure, note that the discrete field is associated with a ply, and therefore cannot be deleted.

Get() [1/3]

DiscreteField hyperx.api.DiscreteFieldCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

DiscreteField hyperx.api.DiscreteFieldCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

DiscreteField hyperx.api.DiscreteFieldCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

Property Documentation

DiscreteFieldColList

hyperx.api.DiscreteFieldCol.DiscreteFieldColList = property

static

---

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

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