hyperx.api.DiscreteField Class Reference

Represents a table of discrete field data. More...

Inheritance diagram for hyperx.api.DiscreteField:

Public Member Functions
	__init__ (self, _api.DiscreteField discreteField)
int	AddColumn (self, str name)
	Create a new column with the given name.
None	AddPointRow (self, Vector3d pointId)
	Create an empty row in a point-based table.
None	DeleteAllRows (self)
	Delete all rows for this discrete field.
None	DeleteColumn (self, int columnId)
	Delete a specified column for this discrete field.
None	DeletePointRow (self, Vector3d pointId)
	Delete a specific row for a point-based table.
None	DeleteRow (self, int entityId)
	Delete a specific row for a non-point-based table.
None	DeleteRowsAndColumns (self)
	Delete all rows and columns for this discrete field.
float|None	ReadNumericCell (self, int entityId, int columnId)
	Valid only for non-point-based discrete fields containing scalar or vector data.
float|None	ReadNumericCell (self, item1=None, item2=None)
	| None`
float|None	ReadNumericCell (self, Vector3d pointId, int columnId)
	Valid only for point-based discrete fields containing scalar or vector data.
str	ReadStringCell (self, int entityId, int columnId)
	Valid only for non point-based discrete fields containing string-based data.
str	ReadStringCell (self, item1=None, item2=None)
str	ReadStringCell (self, Vector3d pointId, int columnId)
	Valid only for point-based discrete fields containing string-based data.
None	SetColumnName (self, int columnId, str name)
None	SetNumericValue (self, int entityId, int columnId, float value)
None	SetNumericValue (self, item1=None, item2=None, item3=None)
None	SetNumericValue (self, Vector3d pointId, int columnId, float value)
None	SetNumericValues (self, dict[int, tuple[float]] valuesByEntityId)
	Set real values for entity based discrete fields in bulk.
None	SetNumericValues (self, dict[Vector3d, tuple[float]] valuesByPoint)
	Set real values for point based discrete fields in bulk.
None	SetNumericValues (self, item1=None)
None	SetStringValue (self, int entityId, int columnId, str value)
None	SetStringValue (self, item1=None, item2=None, item3=None)
None	SetStringValue (self, Vector3d pointId, int columnId, str value)
None	SetStringValues (self, dict[int, tuple[str]] valuesByEntityId)
	Set string values for entity based discrete fields in bulk.
None	SetStringValues (self, dict[Vector3d, tuple[str]] valuesByPoint)
	Set string values for point based discrete fields in bulk.
None	SetStringValues (self, item1=None)
Public Member Functions inherited from hyperx.api.IdNameEntityRenameable
	__init__ (self, _api.IdNameEntityRenameable idNameEntityRenameable)
None	Rename (self, str name)
Public Member Functions inherited from hyperx.api.IdNameEntity
	__init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	ColumnCount = property
	Columns = property
	Lookup of Columns by Id, Name.
	DataType = property
	PhysicalEntityType = property
	PointIds = property
	Get a list of the points for a Discrete Field (point-based only).
	RowCount = property
	RowIds = property
	Get a list of the entity IDs for a Discrete Field (not point-based).
Properties inherited from hyperx.api.IdNameEntity
	Name = property
Properties inherited from hyperx.api.IdEntity
	Id = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdEntity
	_Entity = idEntity

Detailed Description

Represents a table of discrete field data.

Constructor & Destructor Documentation

__init__()

hyperx.api.DiscreteField.__init__	(		self,
		_api.DiscreteField	discreteField )

Member Function Documentation

AddColumn()

int hyperx.api.DiscreteField.AddColumn	(		self,
		str	name )

Create a new column with the given name.

Returns the Id of the newly created column Not valid for discrete fields containing vector data.

AddPointRow()

None hyperx.api.DiscreteField.AddPointRow	(		self,
		Vector3d	pointId )

Create an empty row in a point-based table.

DeleteAllRows()

None hyperx.api.DiscreteField.DeleteAllRows

(

self

)

Delete all rows for this discrete field.

DeleteColumn()

None hyperx.api.DiscreteField.DeleteColumn	(		self,
		int	columnId )

Delete a specified column for this discrete field.

Columns are 1-indexed. Not valid for discrete fields containing vector data.

DeletePointRow()

None hyperx.api.DiscreteField.DeletePointRow	(		self,
		Vector3d	pointId )

Delete a specific row for a point-based table.

DeleteRow()

None hyperx.api.DiscreteField.DeleteRow	(		self,
		int	entityId )

Delete a specific row for a non-point-based table.

DeleteRowsAndColumns()

None hyperx.api.DiscreteField.DeleteRowsAndColumns

(

self

)

Delete all rows and columns for this discrete field.

Not valid for discrete fields containing vector data.

ReadNumericCell() [1/3]

float | None hyperx.api.DiscreteField.ReadNumericCell	(		self,
		int	entityId,
		int	columnId )

Valid only for non-point-based discrete fields containing scalar or vector data.

ReadNumericCell() [2/3]

float | None hyperx.api.DiscreteField.ReadNumericCell	(		self,
			item1 = None,
			item2 = None )

| None`

Valid only for non-point-based discrete fields containing scalar or vector data.

| None`

Valid only for point-based discrete fields containing scalar or vector data.

ReadNumericCell() [3/3]

float | None hyperx.api.DiscreteField.ReadNumericCell	(		self,
		Vector3d	pointId,
		int	columnId )

Valid only for point-based discrete fields containing scalar or vector data.

ReadStringCell() [1/3]

str hyperx.api.DiscreteField.ReadStringCell	(		self,
		int	entityId,
		int	columnId )

Valid only for non point-based discrete fields containing string-based data.

ReadStringCell() [2/3]

str hyperx.api.DiscreteField.ReadStringCell	(		self,
			item1 = None,
			item2 = None )

Valid only for non point-based discrete fields containing string-based data.

Valid only for point-based discrete fields containing string-based data.

ReadStringCell() [3/3]

str hyperx.api.DiscreteField.ReadStringCell	(		self,
		Vector3d	pointId,
		int	columnId )

Valid only for point-based discrete fields containing string-based data.

SetColumnName()

None hyperx.api.DiscreteField.SetColumnName	(		self,
		int	columnId,
		str	name )

SetNumericValue() [1/3]

None hyperx.api.DiscreteField.SetNumericValue	(		self,
		int	entityId,
		int	columnId,
		float	value )

SetNumericValue() [2/3]

None hyperx.api.DiscreteField.SetNumericValue	(		self,
			item1 = None,
			item2 = None,
			item3 = None )

SetNumericValue() [3/3]

None hyperx.api.DiscreteField.SetNumericValue	(		self,
		Vector3d	pointId,
		int	columnId,
		float	value )

SetNumericValues() [1/3]

None hyperx.api.DiscreteField.SetNumericValues	(		self,
		dict[int, tuple[float]]	valuesByEntityId )

Set real values for entity based discrete fields in bulk.

If an entity is included in the lookup, all values for that entity must be set in the collection of values. If an existing entity is included in the lookup with no values, it will be removed from the dataset.

Exceptions

InvalidOperationException

SetNumericValues() [2/3]

None hyperx.api.DiscreteField.SetNumericValues	(		self,
		dict[Vector3d, tuple[float]]	valuesByPoint )

Set real values for point based discrete fields in bulk.

If a point is included in the lookup, all values for that point must be set in the collection of values. If an existing point is included in the lookup with no values, it will be removed from the dataset.

Exceptions

InvalidOperationException

SetNumericValues() [3/3]

None hyperx.api.DiscreteField.SetNumericValues	(		self,
			item1 = None )

Set real values for entity based discrete fields in bulk. If an entity is included in the lookup, all values for that entity must be set in the collection of values. If an existing entity is included in the lookup with no values, it will be removed from the dataset.

Exceptions

InvalidOperationException

Set real values for point based discrete fields in bulk. If a point is included in the lookup, all values for that point must be set in the collection of values. If an existing point is included in the lookup with no values, it will be removed from the dataset.

Exceptions

InvalidOperationException

SetStringValue() [1/3]

None hyperx.api.DiscreteField.SetStringValue	(		self,
		int	entityId,
		int	columnId,
		str	value )

SetStringValue() [2/3]

None hyperx.api.DiscreteField.SetStringValue	(		self,
			item1 = None,
			item2 = None,
			item3 = None )

SetStringValue() [3/3]

None hyperx.api.DiscreteField.SetStringValue	(		self,
		Vector3d	pointId,
		int	columnId,
		str	value )

SetStringValues() [1/3]

None hyperx.api.DiscreteField.SetStringValues	(		self,
		dict[int, tuple[str]]	valuesByEntityId )

Set string values for entity based discrete fields in bulk.

If an entity is included in the lookup, all strings for that entity must be set in the collection of strings. If an existing entity is included in the lookup with no strings, it will be removed from the dataset.

Exceptions

InvalidOperationException

SetStringValues() [2/3]

None hyperx.api.DiscreteField.SetStringValues	(		self,
		dict[Vector3d, tuple[str]]	valuesByPoint )

Set string values for point based discrete fields in bulk.

If a point is included in the lookup, all strings for that point must be set in the collection of strings. If an existing point is included in the lookup with no strings, it will be removed from the dataset.

Exceptions

InvalidOperationException

SetStringValues() [3/3]

None hyperx.api.DiscreteField.SetStringValues	(		self,
			item1 = None )

Set string values for entity based discrete fields in bulk. If an entity is included in the lookup, all strings for that entity must be set in the collection of strings. If an existing entity is included in the lookup with no strings, it will be removed from the dataset.

Exceptions

InvalidOperationException

Set string values for point based discrete fields in bulk. If a point is included in the lookup, all strings for that point must be set in the collection of strings. If an existing point is included in the lookup with no strings, it will be removed from the dataset.

Exceptions

InvalidOperationException

Property Documentation

ColumnCount

hyperx.api.DiscreteField.ColumnCount = property

static

Columns

hyperx.api.DiscreteField.Columns = property

static

Lookup of Columns by Id, Name.

DataType

hyperx.api.DiscreteField.DataType = property

static

PhysicalEntityType

hyperx.api.DiscreteField.PhysicalEntityType = property

static

PointIds

hyperx.api.DiscreteField.PointIds = property

static

Get a list of the points for a Discrete Field (point-based only).

RowCount

hyperx.api.DiscreteField.RowCount = property

static

RowIds

hyperx.api.DiscreteField.RowIds = property

static

Get a list of the entity IDs for a Discrete Field (not point-based).

---

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

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