Subnode – ClearOne Writing StreamNet User Manual

Page 33

Reference

9-3

Main +1 512.977-9393 / fax +1 512.977.9398 / Toll Free Technical Support +1 866-353-3496

3600 W. Parmer Lane, Suite 100; Austin, TX 78727 /

www.netstreams.com.

setStatus(strField, value)

This extension updates the value of a particular field in the associated status object.
This is shorthand for status.setField(field, value). A status field can be deleted by
setting it’s value to nil.

aString = getStatus(strField, value)

Returns the value for the field specified, or nil if the field has not yet been defined.

SubNode

aSubNode = createSubNode(strName)

createSubNode is invoked to create a new named subNode. The newly created
subNode is automatically registered with the control by placing it in the subNodes
table using strName as an index. The newly created subNode will have an empty
status object associated with it and only minimal commands will be handled.

aTable = subNodes

subNodes is a table containing each of the subNodes created with createSubNode,
indexed by subNode name.

aString = aSubNode.name

Holds the name of the subNode as set in createSubNode. Once created the name of the
subNode should not be altered.

aStatus = aSubNode.status

This extension holds the status object for the subNode. Under normal circumstances
the setStatus and getStatus methods should be used in lieu of directly accessing the
status object.

aSubNode:setStatus(strField, value)

Updates or creates a status report field with the indicated value. If the value is actually
being changed this will trigger the automatic generation of a status report when the
execution of the current command, timer, or async input function is completed. A field
that is no longer appropriate can be deleted by calling aSubNode:setStatus(strField,
nil)