Command: GetNodes

NEST HelpDesk Command Index NEST Quick Reference
Name:
GetNodes - Return IDs of all nodes that fulfill the conditions given in
the dictionary, or all nodes if no dictionary given. Returns
only mpi local nodes if local_bool is true.
Synopsis:
<<dict>> local_bool GetNodes -> NodeCollection
Description:
This function recursively traverses all nodes and returns the global
ids of all nodes in increasing order of node_id if local_bool is false, if not, it
returns local nodes. If a dictionary is provided, only those nodes which fulfill
the given criteria are returned.
Parameters:
<<dict>> - Dictionary of selection properties
local_bool - Bool indicating whether or not we want only local nodes.
Returns:
NodeCollection - NodeCollection with the node IDs of all nodes or all mpi
local nodes if local_bool is true.
Source:
/usr/src/packages/BUILD/lib/sli/nest-init.sli
NEST HelpDesk Command Index NEST Quick Reference

© 2004 The NEST Initiative