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	ReadNumericCell (self, int entityId, int columnId)
float	ReadNumericCell (self, item1=None, item2=None)
float	ReadNumericCell (self, Vector3d pointId, int columnId)
str	ReadStringCell (self, int entityId, int columnId)
str	ReadStringCell (self, item1=None, item2=None)
str	ReadStringCell (self, Vector3d pointId, int columnId)
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	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)
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
	DataType = property
	Defines the type of data stored in a Discrete Field.
	PhysicalEntityType = property
	Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc.
	PointIds = property
	RowCount = property
	RowIds = property
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

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.

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.

ReadNumericCell() [1/3]

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

ReadNumericCell() [2/3]

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

ReadNumericCell() [3/3]

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

ReadStringCell() [1/3]

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

ReadStringCell() [2/3]

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

ReadStringCell() [3/3]

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

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 )

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 )

Property Documentation

ColumnCount

hyperx.api.DiscreteField.ColumnCount = property

static

Columns

hyperx.api.DiscreteField.Columns = property

static

DataType

hyperx.api.DiscreteField.DataType = property

static

Defines the type of data stored in a Discrete Field.

Such as Vector, Scalar, String.

PhysicalEntityType

hyperx.api.DiscreteField.PhysicalEntityType = property

static

Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc.

PointIds

hyperx.api.DiscreteField.PointIds = property

static

RowCount

hyperx.api.DiscreteField.RowCount = property

static

RowIds

hyperx.api.DiscreteField.RowIds = property

static

---

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

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