datahub_points
datahub_points — shows the points in a data domain.
Syntax
datahub_points (parent, top_level_only? = nil, pattern?)
Arguments
- parent
- A string containing the name of the
parent domain or point name whose child points you wish
to list.
- top_level_only
- If t, returns only
the direct children of the parent. Otherwise, it returns
all descendents of the parent.
- pattern
- Returns only those points whose full
name (the entire point path without the
domain: prefix) matches the
pattern.
Returns
An array of instances of the
DH_Item
class.
Description
This function provides an
array containing the DataHub points in a given domain. The
pattern can contain the following
special characters:
- * matches any number of
characters, including zero.
- [c] matches a single
character which is a member of the set contained
within the square brackets.
- [^c] matches any single
character which is not a member of the set
contained within the square brackets.
- ? matches a single character.
- {xx,yy} matches either of the simple strings contained within
the braces.
- \c (a
backslash followed by a character) - matches that
character.
Example
—> datahub_points("MySource", t);
[{DH_Item (canonical_type . 0) (conf . 0) (domain . "MySource") (flags . 307)
(n_aliases . 0) (n_attributes . 0) (n_pending . 0)
(n_properties . 0) (n_registered . 1) (n_subassemblies . 1)
(name . "A_Branch") (opcaccessrights . 3) (propid . 0)
(quality . 0) (security . 0) (timestamp . 0) (value)}]
—> datahub_points("MySource", nil, "*em2");
[{DH_Item (canonical_type . 5) (conf . 0) (domain . "MySource") (flags . 579)
(n_aliases . 0) (n_attributes . 0) (n_pending . 0)
(n_properties . 0) (n_registered . 1) (n_subassemblies . 0)
(name . "A_Branch.Ramp.X_Branch.Item2") (opcaccessrights . 3)
(propid . 0) (quality . 192) (security . 0)
(timestamp . 40200.75880280092) (value . 0)}]
