summaryrefslogtreecommitdiffstats
path: root/src/clients/ModelClientInterface.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/clients/ModelClientInterface.h')
-rw-r--r--src/clients/ModelClientInterface.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/src/clients/ModelClientInterface.h b/src/clients/ModelClientInterface.h
new file mode 100644
index 00000000..1f5ea09d
--- /dev/null
+++ b/src/clients/ModelClientInterface.h
@@ -0,0 +1,87 @@
+/* This file is part of Om. Copyright (C) 2005 Dave Robillard.
+ *
+ * Om is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ *
+ * Om is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef MODELCLIENTINTERFACE_H
+#define MODELCLIENTINTERFACE_H
+
+#include <string>
+#include <memory>
+using std::string; using std::auto_ptr;
+#include "interface/ClientInterface.h"
+
+namespace LibOmClient {
+
+class PatchModel;
+class NodeModel;
+class ConnectionModel;
+class PortModel;
+class PluginModel;
+
+
+/** A client interface that creates Model objects to represent the engine's state.
+ *
+ * This calls it's own methods with the models as parameters; clients can inherit
+ * this and implement a class with a similar interface to ClientInterface except
+ * with model classes passed where appropriate instead of primitives.
+ *
+ * \ingroup libomclient
+ */
+class ModelClientInterface : virtual public Om::Shared::ClientInterface
+{
+public:
+ ModelClientInterface(Om::Shared::ClientInterface& extend)
+ : Om::Shared::ClientInterface(extend)
+ {}
+
+ virtual ~ModelClientInterface() {}
+
+ // FIXME: make these auto_ptr's
+
+ virtual void new_plugin_model(PluginModel* pi);
+ virtual void new_patch_model(PatchModel* pm);
+ virtual void new_node_model(NodeModel* nm);
+ virtual void new_port_model(PortModel* port_info);
+ virtual void connection_model(ConnectionModel* cm);
+
+ // ClientInterface functions to drive the above:
+
+ virtual void new_plugin(const string& type,
+ const string& uri,
+ const string& name);
+
+ virtual void new_patch(const string& path, uint32_t poly);
+
+ virtual void new_node(const string& plugin_type,
+ const string& plugin_uri,
+ const string& node_path,
+ bool is_polyphonic,
+ uint32_t num_ports);
+
+ virtual void new_port(const string& path,
+ const string& data_type,
+ bool is_output);
+
+ virtual void connection(const string& src_port_path,
+ const string& dst_port_path);
+
+protected:
+ ModelClientInterface() {}
+};
+
+
+} // namespace LibOmClient
+
+#endif // MODELCLIENTINTERFACE_H