/*-
*******************************************************************************
* Copyright (c) 2011, 2016 Diamond Light Source Ltd.
* 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:
* Matthew Gerring - initial API and implementation and/or initial documentation
*******************************************************************************/
package org.eclipse.dawnsci.remotedataset.client.dyn;
import org.eclipse.january.dataset.IDataset;
import org.eclipse.january.dataset.IDatasetConnector;
/**
* NON-API DO NOT USE OUTSIDE THIS BUNDLE
*
* Instead if you need an MJPG Dataset use:
*
* IRemoteDatasetService service = ... // OSGi
* IDataset rgb = service.createMJPGDataset(...).getDataset()
*
* then plot RGB
*
* @author Matthew Gerring
*
*/
public interface IDynamicMonitorDatasetHolder extends IDatasetConnector {
/**
* Internal use only. When the dataset changes, the internal API may update the
* underlying data which the dataset is linked to.
*
* @param newData
*/
public void setDataset(IDataset newData);
/**
* Starts notifying the IDataListener's with the current
* thread, blocking until there are no more images.
*
* @throws Exception
*/
public void start() throws Exception;
/**
* Starts notifying the IDataListener's with the current
* thread, blocking until there are no more images or if
* maxImages>0 until that number of images has been received.
*
* @throws Exception
*/
public void start(int maxImages) throws Exception;
}