Vertex Queries
This section contains reference material on the available tag names and corresponding type for all vertex-based query diagnostics.
Note | The same limitations and conditions apply to using vertex-based queries in macros as with using the GUI. See Vertex Query Tools for more information. |
Vertex Location
The following response properties are available for single vertex selections.
Tag Name | Type | Description |
---|---|---|
VertexId |
Int |
Vertex ID of the selected vertex |
LabXYZ |
Vector<Double> |
Coordinates of the selected vertex relative to the laboratory coordinate system |
LocalXYZ |
Vector<Double> |
Coordinates of the selected vertex relative to the local coordinate system |
CoordinateSystem |
ClientServerObject<CoordinateSystem> |
Coordinate system for the query |
LengthUnits |
ClientServerObject<Units> |
Preferred length units for the query |
AngleUnits |
ClientServerObject<Units> |
Preferred angle units for the query |
The following response properties are available for single and multiple vertex selections.
Tag Name | Type | Description |
---|---|---|
AllVertexIds |
Int |
Vertex ID's of the selected vertices |
AllLabXYZCoords |
Vector<Double> |
List of the coordinates of the selected vertices relative to the laboratory coordinate system |
AllLocalXYZCoords |
Vector<Double> |
List of the coordinates of the selected vertices relative to the local coordinate system (only available if you set a local coordinate system) |
Vertex Distance
Tag Name | Type | Description |
---|---|---|
StartVertexId |
Int |
Vertex ID of the starting vertex |
EndVertexId |
Int |
Vertex ID of the ending vertex |
VertexDistance |
Double |
Distance between vertices |
StartVertexLabCoordinates |
Vector<Double> |
Coordinates of the starting vertex relative to the laboratory coordinate system |
EndVertexLabCoordinates |
Vector<Double> |
Coordinates of the ending vertex relative to the laboratory coordinate system |
XYZComponents |
Vector<Double> |
X, Y, and Z components of distance from minimum to maximum |
LengthUnits |
ClientServerObject<Units> |
Preferred length units for the query |
StartVertexLocalCoordinates |
Vector<Double> |
Starting vertex local coordinates |
EndVertexLocalCoordinates |
Vector<Double> |
Ending vertex local coordinates |
XYZLocalComponents |
Vector<Double> |
XYZ local coordinate system components from minimum to maximum in preferred units |
AngleUnits |
ClientServerObject<Units> |
Preferred angle units specified for query |
LocalCoordinateSystem |
ClientServerObject<CoordinateSystem> |
Coordinate system specified for query |
Vertex Range
Tag Name | Type | Description |
---|---|---|
LabMinRange |
Vector<Double> |
Minimum range relative to the laboratory coordinate system |
LabMaxRange |
Vector<Double> |
Maximum range relative to the laboratory coordinate system |
XYZComponents |
Vector<Double> |
X, Y, and Z components of range from minimum to maximum |
LengthUnits |
ClientServerObject<Units> |
Preferred length units for the query |