vectors

Unless otherwise specified, data names are accessible in level 3 only.

attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
basenode
A pointer to the node to which the vector is attached.
Type: pointer
basenodeid
The ID of the node to which the vector is attached.
Type: integer
collector
Pointer to the collector that owns the element.
Type: pointer (levels 2, 3 and 4)
collectorid
The ID of the collector that owns the vector.
Type: integer
components
The components of the vector. Valid for hm_getvalue query only.
Type: triple double
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
farnode
A pointer to the node at the vector tip if the two-node method was used to create the vector. Otherwise, all values return zero.
Type: pointer
farnodeid
The ID of the node at the vector tip if the two-node method was used to create the vector. Otherwise, returns zero.
Type: integer
id
The ID of the entity.
Type: unsigned integer
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internalid
The ID of the entity.
Type: unsigned integer
magnitude
The magnitude of the vector.
Type: double
moduleid
The module ID of the entity.
Type: integer
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
system
Pointer to the local coordinate system in which the vector is defined.
Type: pointer levels 2, 3 and 4.
systemid
The ID of the local coordinate system in which the vector is defined or 0 for the global system.
Type: integer
xcomp
The x component of the vector.
Type: double
ycomp
The y component of the vector.
Type: double
zcomp
The z component of the vector.
Type: double

Version History

2020.1 - Added new data name solverkeyword.

2021.1 - Added new data names moduleid, poolid, poolname, and solver_id.