Member Function Documentation

[virtual] ICDPNode::~ICDPNode()

Destroys the instance of ICDPNode. The destructor is virtual.

[pure virtual] bool ICDPNode::AddChild(const std::string &name, const std::string &typeName, const std::string &configuration)

[pure virtual] void ICDPNode::FillNodeChildren(NodeStream &serializer) const

[virtual] const ICDPNode *ICDPNode::GetChild(const std::string &pathInParent) const

Returns a child node with a matching fullPath if it is published through the FillNodeChildren method.

Warning: CDPComponent children can run in a different thread context. It is not recommended to access them directly using this method (use instead a CDPConnector to send messages) but if you do, remember to lock the member access mutex:

auto child = GetChild("MyComponent");
if (child->GetNodeType() == CDP::StudioAPI::eCDP_COMPONENT_NODE)
{
    // Note: Consider using a CDPConnector instead of directly accessing a subcomponent pointer
    if (auto subcomponent = const_cast<CDPComponent*>(dynamic_cast<const CDPComponent*>(child)))
    {
        OSAPIMutexLocker lock(subcomponent->GetMemberAccessMutex());
        ProcessChild(subcomponent);
    }
}
else // Non-component children always run in my thread context
    ProcessChild(child);

[virtual] std::vector<const ICDPNode *> ICDPNode::GetChildren() const

Returns a list of child nodes published through the FillNodeChildren method.

Warning: CDPComponent children can run in a different thread context. It is not recommended to access them directly using this method (use instead a CDPConnector to send messages) but if you do, remember to lock the member access mutex:

for (auto child : GetChildren());
{
    if (child->GetNodeType() == CDP::StudioAPI::eCDP_COMPONENT_NODE)
    {
        if (auto subcomponent = const_cast<CDPComponent*>(dynamic_cast<const CDPComponent*>(child)))
        {
            // Note: Consider using a CDPConnector instead of directly accessing a subcomponent pointer
            OSAPIMutexLocker lock(subcomponent->GetMemberAccessMutex());
            ProcessChild(subcomponent);
        }
    }
    else // Non-component children always run in my thread context
        ProcessChild(child);
}

[virtual] CDPNodePermissionFlags ICDPNode::GetEffectivePermissionFlags(const std::shared_ptr<IAuthSession> &session) const

[pure virtual] std::shared_ptr<ICDPNodeAPI> ICDPNode::GetNodeAPI() const

[pure virtual] unsigned int ICDPNode::GetNodeID() const

[virtual] std::string ICDPNode::GetNodeLongName() const

Returns the full path of the node, e.g. "MyApp.MyComp.MyObject.MyNode".

[pure virtual] CDPNodeModeFlags ICDPNode::GetNodeModeFlags() const

[pure virtual] const std::string ICDPNode::GetNodeName() const

[pure virtual] ICDPNode *ICDPNode::GetNodeOwner() const

[pure virtual] CDPNodeType ICDPNode::GetNodeType() const

[pure virtual] std::string ICDPNode::GetNodeTypeName() const

[pure virtual] CDPValueType ICDPNode::GetNodeValueType() const

[virtual] INodePermissions *ICDPNode::GetPermissionHandler() const

[pure virtual] CDPVariantValue ICDPNode::GetVariantValue() const

[pure virtual] bool ICDPNode::IsNodeAbsorbed() const

[pure virtual] bool ICDPNode::IsNodeLocal() const

[pure virtual] bool ICDPNode::IsNodeReparented() const

[pure virtual] bool ICDPNode::RemoveChild(const std::string &name)

[pure virtual] void ICDPNode::SetNodeOwner(ICDPNode *parent) const

[pure virtual] void ICDPNode::SetVariantValue(const CDPVariantValue &value)