Description This function queries a node and returns a True or False indicating whether the node is a data collector surface object. If the node being queried is not a surface, then the function halts with an error indicating that the node is the wrong type.
Syntax isCol = IsDataCollectorSurf( node )
Parameters isCol (Boolean) Return value indicating that the node is a data collector surface object.
node As Long Node number of the surface being queried.
Example The example below demonstrates how to loop over the objects in a FRED model, identify the surfaces using the IsSurface function and then query each surface to report whether it is a data collector surface and print its surface type.
Sub Main
'Header Print "" Print "Is Collector?" & Chr(9) & "Surf Type"
Dim curNode As Long For curNode = 5 To GetEntityCount()-1 If IsSurface( curNode ) Then Print IsDataCollectorSurf( curNode ); Print GetType( curNode ) End If Next
End Sub
See Also Data Collector Surface Scripting DataCollectorSurfGetDatumCount DataCollectorSurfIsCollectData DataCollectorSurfIsDataAvailable DataCollectorSurfReadCollectedDataFile DataCollectorSurfSetCollectData DataCollectorSurfWriteCollectedDataFile
|