Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.simulation / src / org / simantics / simulation / data / VariableHandle.java

diff --git a/bundles/org.simantics.simulation/src/org/simantics/simulation/data/VariableHandle.java b/bundles/org.simantics.simulation/src/org/simantics/simulation/data/VariableHandle.java
new file mode 100644 (file)
index 0000000..94d40bc
--- /dev/null
+++ b/bundles/org.simantics.simulation/src/org/simantics/simulation/data/VariableHandle.java
@@ -0,0 +1,45 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007 VTT Technical Research Centre of Finland and others.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.simulation.data;\r
+\r
+import org.simantics.databoard.accessor.error.AccessorException;\r
+import org.simantics.databoard.binding.Binding;\r
+\r
+/**\r
+ * A handle to a variable of a {@link Datasource}.\r
+ *\r
+ * @author Toni Kalajainen <toni.kalajainen@vtt.fi>\r
+ */\r
+public interface VariableHandle {\r
+\r
+       /**\r
+        * @return key (ID) of the variable\r
+        */\r
+       String key();\r
+\r
+       /**\r
+        * @return binding for the variable\r
+        */\r
+       Binding binding();\r
+\r
+       /**\r
+        * @return current value associated with this handle\r
+        * @throws AccessorException if value cannot be retrieved\r
+        */\r
+       Object getValue() throws AccessorException;\r
+\r
+       /**\r
+        * Frees any resource related to this handle.\r
+        */\r
+       void dispose();\r
+\r
+}\r
+\r