summaryrefslogtreecommitdiff
path: root/include/gras/element.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/gras/element.hpp')
-rw-r--r--include/gras/element.hpp76
1 files changed, 76 insertions, 0 deletions
diff --git a/include/gras/element.hpp b/include/gras/element.hpp
new file mode 100644
index 0000000..3142510
--- /dev/null
+++ b/include/gras/element.hpp
@@ -0,0 +1,76 @@
+//
+// Copyright 2012 Josh Blum
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program 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 Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+#ifndef INCLUDED_GRAS_ELEMENT_HPP
+#define INCLUDED_GRAS_ELEMENT_HPP
+
+#include <gras/gras.hpp>
+#include <gras/io_signature.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/enable_shared_from_this.hpp>
+
+namespace gras
+{
+
+class ElementImpl;
+
+struct GRAS_API Element : boost::shared_ptr<ElementImpl>, boost::enable_shared_from_this<Element>
+{
+
+ //! Create an empty element
+ Element(void);
+
+ //! Creates a new element given the name
+ Element(const std::string &name);
+
+ /*!
+ * Create an element from a shared pointer to an element.
+ * Good for that factory function/shared ptr paradigm.
+ */
+ template <typename T>
+ Element(const boost::shared_ptr<T> &elem)
+ {
+ *this = elem->shared_to_element();
+ }
+
+ //! Convert a shared ptr of a derived class to an Element
+ Element &shared_to_element(void);
+
+ //! for internal use only
+ boost::weak_ptr<Element> weak_self;
+
+ //! An integer ID that is unique across the process
+ long unique_id(void) const;
+
+ //! Get the name of this element
+ std::string name(void) const;
+
+ //! get a canonical name for this element
+ std::string to_string(void) const;
+
+ void set_output_signature(const gras::IOSignature &sig);
+
+ void set_input_signature(const gras::IOSignature &sig);
+
+ const gras::IOSignature &input_signature(void) const;
+
+ const gras::IOSignature &output_signature(void) const;
+
+};
+
+} //namespace gras
+
+#endif /*INCLUDED_GRAS_ELEMENT_HPP*/