Warning: preg_replace(): Compilation failed: invalid range in character class at offset 4 in /home/customer/www/qualgame.com/public_html/wp-content/plugins/crayon-syntax-highlighter/crayon_langs.class.php on line 340
Node User Attribute | BtEngineSDK

Node User Attribute

Table of contents

1. Get a dictionary that contains all the user attribute key-value pairs
2. Get the number of user attributes
3. Determine whether a user attribute is contained
4. Get the value of a user attribute

1. Get a dictionary that contains all the user attribute key-value pairs
1.1. in a forest
Signature:
static Tuple<bool, Dictionary<string, string>> BtEngine.NodeUserAttr.Get(string ForestName)
static Tuple<bool, Dictionary<string, string>> BtEngine.NodeUserAttr.Get(uint ForestIndex)
Description:
Gets a dictionary that contains all the user attribute key-value pairs in a forest instance with the specified (forest) name/index.
Parameters:
ForestName The name of the forest instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
Return Value:
A tuple. Item1: true if the forest instance with the specified (forest) name/index was present; false otherwise. Item2: a dictionary that contains all the user attribute key-value pairs in the forest instance if Item1 is true; null otherwise.
Complexity:
O(log f + a), where f is the count of forest instance and a is the count of user attribute.
1.2. in a tree
Signature:
static Tuple<bool, Dictionary<string, string>> BtEngine.NodeUserAttr.Get(string ForestName, string TreeName)
static Tuple<bool, Dictionary<string, string>> BtEngine.NodeUserAttr.Get(uint ForestIndex, uint TreeIndex)
Description:
Gets a dictionary that contains all the user attribute key-value pairs in a tree instance with the specified (forest, tree) names/indices.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
Return Value:
A tuple. Item1: true if the tree instance with the specified (forest, tree) names/indices was present; false otherwise. Item2: a dictionary that contains all the user attribute key-value pairs in the tree instance if Item1 is true; null otherwise.
Complexity:
O(log f + log t + a), where f is the count of forest instance, t is the count of whose child tree instance and a is the count of user attribute.
1.3. in a node
Signature:
static Tuple<bool, Dictionary<string, string>> BtEngine.NodeUserAttr.Get(string ForestName, string TreeName, string NodeName)
static Tuple<bool, Dictionary<string, string>> BtEngine.NodeUserAttr.Get(uint ForestIndex, uint TreeIndex, uint NodeIndex)
Description:
Gets a dictionary that contains all the user attribute key-value pairs in a node instance with the specified (forest, tree, node) names/indices.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
NodeName The name of the node instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
NodeIndex The index of the node instance to locate and invoke.
Return Value:
A tuple. Item1: true if the node instance with the specified (forest, tree, node) names/indices was present; false otherwise. Item2: a dictionary that contains all the user attribute key-value pairs in the node instance if Item1 is true; null otherwise.
Complexity:
O(log f + log t + 1 + a), where f is the count of forest instance, t is the count of whose child tree instance and a is the count of user attribute.
2. Get the number of user attributes
2.1. in a forest
Signature:
static Tuple<bool, uint> BtEngine.NodeUserAttr.Count(string ForestName)
static Tuple<bool, uint> BtEngine.NodeUserAttr.Count(uint ForestIndex)
Description:
Gets the number of user attributes in a forest instance with the specified (forest) name/index.
Parameters:
ForestName The name of the forest instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
Return Value:
A tuple. Item1: true if the forest instance with the specified (forest) name/index was present; false otherwise. Item2: the number of user attributes in the forest instance if Item1 is true; 0 otherwise.
Complexity:
O(log f + 1), where f is the count of forest instance.
2.2. in a tree
Signature:
static Tuple<bool, uint> BtEngine.NodeUserAttr.Count(string ForestName, string TreeName)
static Tuple<bool, uint> BtEngine.NodeUserAttr.Count(uint ForestIndex, uint TreeIndex)
Description:
Gets the number of user attributes in a tree instance with the specified (forest, tree) names/indices.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
Return Value:
A tuple. Item1: true if the tree instance with the specified (forest, tree) names/indices was present; false otherwise. Item2: the number of user attributes in the tree instance if Item1 is true; 0 otherwise.
Complexity:
O(log f + log t + 1), where f is the count of forest instance and t is the count of whose child tree instance.
2.3. in a node
Signature:
static Tuple<bool, uint> BtEngine.NodeUserAttr.Count(string ForestName, string TreeName, string NodeName)
static Tuple<bool, uint> BtEngine.NodeUserAttr.Count(uint ForestIndex, uint TreeIndex, uint NodeIndex)
Description:
Gets the number of user attributes in a node instance with the specified (forest, tree, node) names/indices.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
NodeName The name of the node instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
NodeIndex The index of the node instance to locate and invoke.
Return Value:
A tuple. Item1: true if the node instance with the specified (forest, tree, node) names/indices was present; false otherwise. Item2: the number of user attributes in the node instance if Item1 is true; 0 otherwise.
Complexity:
O(log f + log t + 1 + 1), where f is the count of forest instance and t is the count of whose child tree instance.
3. Determine whether a user attribute is contained
3.1. in a forest
Signature:
static Tuple<bool, bool> BtEngine.NodeUserAttr.ContainsKey(string ForestName, string Key)
static Tuple<bool, bool> BtEngine.NodeUserAttr.ContainsKey(uint ForestIndex, string Key)
Description:
Determines whether a forest instance with the specified (forest) name/index contains a user attribute associated with the specified key.
Parameters:
ForestName The name of the forest instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
Key The key of the user attribute whose presence is to be determined.
Return Value:
A tuple. Item1: true if the forest instance with the specified (forest) name/index was present; false otherwise. Item2: true if Item1 is true and the user attribute associated with the specified key was present; false otherwise.
Complexity:
O(log f + log a), where f is the count of forest instance and a is the count of user attribute.
3.2. in a tree
Signature:
static Tuple<bool, bool> BtEngine.NodeUserAttr.ContainsKey(string ForestName, string TreeName, string Key)
static Tuple<bool, bool> BtEngine.NodeUserAttr.ContainsKey(uint ForestIndex, uint TreeIndex, string Key)
Description:
Determines whether a tree instance with the specified (forest, tree) names/indices contains a user attribute associated with the specified key.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
Key The key of the user attribute whose presence is to be determined.
Return Value:
A tuple. Item1: true if the tree instance with the specified (forest, tree) names/indices was present; false otherwise. Item2: true if Item1 is true and the user attribute associated with the specified key was present; false otherwise.
Complexity:
O(log f + log t + log a), where f is the count of forest instance, t is the count of whose child tree instance and a is the count of user attribute.
3.3. in a node
Signature:
static Tuple<bool, bool> BtEngine.NodeUserAttr.ContainsKey(string ForestName, string TreeName, string NodeName, string Key)
static Tuple<bool, bool> BtEngine.NodeUserAttr.ContainsKey(uint ForestIndex, uint TreeIndex, uint NodeIndex, string Key)
Description:
Determines whether a node instance with the specified (forest, tree, node) names/indicies contains a user attribute associated with the specified key.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
NodeName The name of the node instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
NodeIndex The index of the node instance to locate and invoke.
Key The key of the user attribute whose presence is to be determined.
Return Value:
A tuple. Item1: true if the node instance with the specified (forest, tree, node) names/indices was present; false otherwise. Item2: true if Item1 is true and the user attribute associated with the specified key was present; false otherwise.
Complexity:
O(log f + log t + 1 + log a), where f is the count of forest instance, t is the count of whose child tree instance and a is the count of user attribute.
4. Get the value of a user attribute
4.1. in a forest
Signature:
static Tuple<bool, bool, string> BtEngine.NodeUserAttr.GetValue(string ForestName, string Key)
static Tuple<bool, bool, string> BtEngine.NodeUserAttr.GetValue(uint ForestIndex, string Key)
Description:
Gets the value of a user attribute associated with the specified key in a forest instance with the specified (forest) name/index.
Parameters:
ForestName The name of the forest instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
Key The key of the user attribute whose associated value is to be returned.
Return Value:
A tuple. Item1: true if the forest instance with the specified (forest) name/index was present; false otherwise. Item2: true if Item1 is true and the user attribute associated with the specified key was present; false otherwise. Item3: the value of the user attribute associated with the specified key if both Item1 and Item2 are true; an empty string otherwise.
Complexity:
O(log f + log a), where f is the count of forest instance and a is the count of user attribute.
4.2. in a tree
Signature:
static Tuple<bool, bool, string> BtEngine.NodeUserAttr.GetValue(string ForestName, string TreeName, string Key)
static Tuple<bool, bool, string> BtEngine.NodeUserAttr.GetValue(uint ForestIndex, uint TreeIndex, string Key)
Description:
Gets the value of a user attribute associated with the specified key in a tree instance with the specified (forest, tree) names/indices.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
Key The key of the user attribute whose associated value is to be returned.
Return Value:
A tuple. Item1: true if the tree instance with the specified (forest, tree) names/indices was present; false otherwise. Item2: true if Item1 is true and the user attribute associated with the specified key was present; false otherwise. Item3: the value of the user attribute associated with the specified key if both Item1 and Item2 are true; an empty string otherwise.
Complexity:
O(log f + log t + log a), where f is the count of forest instance, t is the count of whose child tree instance and a is the count of user attribute.
4.3. in a node
Signature:
static Tuple<bool, bool, string> BtEngine.NodeUserAttr.GetValue(string ForestName, string TreeName, string NodeName, string Key)
static Tuple<bool, bool, string> BtEngine.NodeUserAttr.GetValue(uint ForestIndex, uint TreeIndex, uint NodeIndex, string Key)
Description:
Gets the value of a user attribute associated with the specified key in a node instance with the specified (forest, tree, node) names/indices.
Parameters:
ForestName The name of the forest instance to locate and invoke.
TreeName The name of the tree instance to locate and invoke.
NodeName The name of the node instance to locate and invoke.
ForestIndex The index of the forest instance to locate and invoke.
TreeIndex The index of the tree instance to locate and invoke.
NodeIndex The index of the node instance to locate and invoke.
Key The key of the user attribute whose associated value is to be returned.
Return Value:
A tuple. Item1: true if the node instance with the specified (forest, tree, node) names/indices was present; false otherwise. Item2: true if Item1 is true and the user attribute associated with the specified key was present; false otherwise. Item3: the value of the user attribute associated with the specified key if both Item1 and Item2 are true; an empty string otherwise.
Complexity:
O(log f + log t + 1 + log a), where f is the count of forest instance, t is the count of whose child tree instance and a is the count of user attribute.