Detailed Description

A template class that provides value node functionality to any base node type.

ValueNode Class

ValueNode is a template class that provides a value node functionality to any CDP base node type. A value node is a node that has a value child that holds the actual value of the node. The value node acts as a proxy to its value child. All value-related calls to the value node are forwarded to the value child. And vice versa, all value-related events from the value child are forwarded to the value node.

In addition to CDPVariantValue-related proxying, ValueNode also supports value child metadata and external value proxying.

ValueNode class implementers need not call CDP::StudioAPI::CDPNode::NotifyValueChange nor CDP::StudioAPI::CDPNode::NotifyMetadataChange methods on value child changes manually, as these are called automatically by the ValueNode class, which registers itself as an CDP::StudioAPI::AbstractValueListener to the value child node. And because of that, the ValueNode class implementers can not to register themselves as an CDP::StudioAPI::AbstractValueListener anymore. But implementers can override the relevant CDP::StudioAPI::AbstractValueListener methods in their implementation to get them notified about value or metadata changes as well, if needed.

Example usage for creating a CDPNode-based value node:

class MyValueNode : public ValueNode<CDP::StudioAPI::CDPNode>
{
public:
  MyValueNode() { SetValueChild(&m_value); }

private:
  CDPProperty<double> m_value;
}

Example usage for creating a CDPBaseObject-based value node:

class MyValueObject : public ValueNode<CDPBaseObject>
{
public:
  MyValueObject() { SetValueChild(&m_value); }

private:
 CDPProperty<double> m_value;
}