libdatanetwork – overview and manual

Classes you should use in your client program:

DataNetwork

  • create an instance
  • createOSC() - to set up the OSC connection
  • debug() - to turn on and off some debugging messages
  • registerMe() - to register the client
  • query() - query what is in the network

Node interaction:

  • updateNode() - update the values of a node once
  • subscribeNode() - subscribe to a node
  • unSubscribeNode() - unsubscribe from a node
  • getNode() - get a reference to the actual DataNode

Only for nodes you create:

  • createNode() - create a node
  • labelNode() - label a node
  • removeNode() - create a node

Slot interaction:

  • updateSlot() - update the value of a slot once
  • subscribeSlot() - subscribe to a slot
  • unSubscribeSlot() - unsubscribe from a slot
  • getSlot() - get a reference to the actual DataSlot

Only for nodes/slots you create:

  • labelSlot() - label a slot

DataNode:

  • getData() - get a reference to the data
  • getStringData() - get a reference to the string data (if the node contains string data)
  • getLabel() - get the node’s label
  • getID() - get the node’s ID
  • size() - get the number of slots, data size…
  • getType() - get the node’s type (0 is float, 1 is string)
  • setData() - set data to a node (if you created the node)
  • send() - send the data to the network
  • isSubscribed() - check whether the node is subscribed
  • isSetter() - check whether you are the setter of the node

DataSlot:

  • getValue() - get the current value
  • getStringValue() - get the current string value
  • getLabel() - get the slot’s label
  • getID() - get the slot’s ID
  • getType() - get the slot’s type (0 is float, 1 is string)
  • isSubscribed() - check whether the slot is subscribed

Further documentation

  • Extensive HTML documentation can be created with Doxygen.
  • Also look at the supplied example.

Comments/Questions

Comments are closed.