2.3.3.3.130. NXgraph_edge_set¶
Status:
base class, extends NXobject
Description:
A set of (eventually directed) edges which connect nodes of a graph. ...
A set of (eventually directed) edges which connect nodes of a graph.
Use as a direct child of an instance of NXgraph_root. Alternatively, use depends_on to specify which instance of NXgraph_root is defined by this instance.
Symbols:
The symbols used in the schema to specify e.g. dimensions of arrays.
n_edges: The number of edges.
- Groups cited:
none
Structure:
depends_on: (optional) NX_CHAR
Specify which instance of :ref:`NXgraph_root` this :ref:`NXgraph_edge_set` ...
Specify which instance of NXgraph_root this NXgraph_edge_set refers to.
number_of_edges: (optional) NX_UINT {units=NX_UNITLESS}
Total number of edges, counting eventual bidirectional edges only once.
identifier_offset: (optional) NX_INT {units=NX_UNITLESS}
Integer which specifies the first index to be used for distinguishing ...
Integer which specifies the first index to be used for distinguishing edges. Identifiers are defined either implicitly or explicitly.
For implicit indexing the identifiers are defined on the interval \([identifier\_offset, identifier\_offset + c - 1]\).
For explicit indexing use the field identifier. For implicit indexing, consult NXcg_primitive_set to get guidance how to set identifier_offset.
identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_edges]) {units=NX_UNITLESS}
Integer used to distinguish edges for explicit indexing.
directionality: (optional) NX_UINT (Rank: 1, Dimensions: [n_edges]) {units=NX_UNITLESS}
Specifier whether each edge is non-directional, one-directional, ...
Specifier whether each edge is non-directional, one-directional, or bidirectional. Use the smallest available binary representation which can store three different states:
0 / state 0x00 is non-directional
1 / state 0x01 is one-directional
2 / state 0x02 is bi-directional
node_pair: (optional) NX_INT (Rank: 2, Dimensions: [n_edges, 2]) {units=NX_UNITLESS}
Pairs of node/vertex identifier. Each pair represents the connection ...
Pairs of node/vertex identifier. Each pair represents the connection between two nodes. The order in the pair encodes eventual directionality.
In the case that an edge is non- or bi-directional, storing node identifier in ascending order is preferred.
In the case that an edge is one-directional, node identifier should be stored such that the identifier of the source node is the first entry and the identifier of the target is the second entry in the pair.
is_a: (optional) NX_CHAR (Rank: 1, Dimensions: [n_edges])
A human-readable qualifier which type or e.g. class instance the ...
A human-readable qualifier which type or e.g. class instance the edge is an instance of.
label: (optional) NX_CHAR (Rank: 1, Dimensions: [n_edges])
A human-readable label/caption/tag of each edge.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
