X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.simulation%2Fsrc%2Forg%2Fsimantics%2Fsimulation%2Fdata%2FVariableHandle.java;h=360ea96fc2db48b3e3a031d67212d54888cafeef;hb=b000e272429e157638c0384878b07b8dcd758472;hp=94d40bcd0b8951eae49b54da8013329c792adfa0;hpb=969bd23cab98a79ca9101af33334000879fb60c5;p=simantics%2Fplatform.git 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 index 94d40bcd0..360ea96fc 100644 --- a/bundles/org.simantics.simulation/src/org/simantics/simulation/data/VariableHandle.java +++ b/bundles/org.simantics.simulation/src/org/simantics/simulation/data/VariableHandle.java @@ -1,45 +1,51 @@ -/******************************************************************************* - * Copyright (c) 2007 VTT Technical Research Centre of Finland and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * VTT Technical Research Centre of Finland - initial API and implementation - *******************************************************************************/ -package org.simantics.simulation.data; - -import org.simantics.databoard.accessor.error.AccessorException; -import org.simantics.databoard.binding.Binding; - -/** - * A handle to a variable of a {@link Datasource}. - * - * @author Toni Kalajainen - */ -public interface VariableHandle { - - /** - * @return key (ID) of the variable - */ - String key(); - - /** - * @return binding for the variable - */ - Binding binding(); - - /** - * @return current value associated with this handle - * @throws AccessorException if value cannot be retrieved - */ - Object getValue() throws AccessorException; - - /** - * Frees any resource related to this handle. - */ - void dispose(); - -} - +/******************************************************************************* + * Copyright (c) 2007 VTT Technical Research Centre of Finland and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * VTT Technical Research Centre of Finland - initial API and implementation + *******************************************************************************/ +package org.simantics.simulation.data; + +import org.simantics.databoard.accessor.error.AccessorException; +import org.simantics.databoard.binding.Binding; + +/** + * A handle to a variable of a {@link Datasource}. + * + * @author Toni Kalajainen + */ +public interface VariableHandle { + + /** + * @return key (ID) of the variable + */ + String key(); + + /** + * @return binding for the variable + */ + Binding binding(); + + /** + * @return current value associated with this handle + * @throws AccessorException if value cannot be retrieved + */ + Object getValue() throws AccessorException; + + /** + * @return current value associated with this handle within the given Datasource + * @throws AccessorException if value cannot be retrieved + */ + Object getValue(Datasource datasource) throws AccessorException; + + /** + * Frees any resource related to this handle. + */ + void dispose(); + +} +