libIntegra
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Static Public Member Functions | List of all members
integra_api::INewCommand Class Reference

Command to add new nodes to the node hierarchy. More...

#include "api/command.h"

Inheritance diagram for integra_api::INewCommand:
Inheritance graph
[legend]
Collaboration diagram for integra_api::INewCommand:
Collaboration graph
[legend]

Static Public Member Functions

static INewCommandcreate (const GUID &module_id, const string &node_name, const CPath &parent_path)
 Create an instance of INewCommand Use INewCommand to create nodes (aka modules instances). More...
 

Additional Inherited Members

- Public Member Functions inherited from integra_api::ICommand
virtual CError execute (integra_internal::CServer &server, CCommandSource source, CCommandResult *result)=0
 Internal use only.
 

Detailed Description

Command to add new nodes to the node hierarchy.

Member Function Documentation

static INewCommand* integra_api::INewCommand::create ( const GUID module_id,
const string &  node_name,
const CPath parent_path 
)
static

Create an instance of INewCommand Use INewCommand to create nodes (aka modules instances).

Parameters
module_idthe guid of the module you want to instantiate (see IInterfaceDefinition)
node_namename for the new module instance. Must be unique within siblings, must only use characters within CStringHelper::node_name_character_set
parent_pathnode instance under which to create the new node. Supply an empty CPath to create a top-level node.
Returns
a pointer to the command, created on the heap.

The documentation for this class was generated from the following file: