org.eclipse.om2m.sdt/org.eclipse.om2m.sdt.home/src/main/java/org/eclipse/om2m/sdt/home/modules/PushButton.java

/*******************************************************************************
 * Copyright (c) 2014, 2016 Orange.
 * 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
 *******************************************************************************/
package org.eclipse.om2m.sdt.home.modules;

import java.util.Map;

import org.eclipse.om2m.sdt.DataPoint;
import org.eclipse.om2m.sdt.Domain;
import org.eclipse.om2m.sdt.Module;
import org.eclipse.om2m.sdt.datapoints.BooleanDataPoint;
import org.eclipse.om2m.sdt.exceptions.AccessException;
import org.eclipse.om2m.sdt.exceptions.DataPointException;
import org.eclipse.om2m.sdt.home.types.DatapointType;
import org.eclipse.om2m.sdt.home.types.ModuleType;

public class PushButton extends Module {
	
	private BooleanDataPoint pushed;
	
	public PushButton(final String name, final Domain domain, 
			BooleanDataPoint pushed) {
		super(name, domain, ModuleType.pushButton);

		if ((pushed == null) ||
				! pushed.getShortName().equals(DatapointType.pushed.getShortName())) {
			domain.removeModule(getName());
			throw new IllegalArgumentException("Wrong pushed datapoint: " + pushed);
		}
		this.pushed = pushed;
		this.pushed.setWritable(false);
		this.pushed.setDoc("To indicate the press of the button.");
		addDataPoint(this.pushed);
	}

	public PushButton(final String name, final Domain domain, Map<String, DataPoint> dps) {
		this(name, domain, (BooleanDataPoint) dps.get(DatapointType.pushed.getShortName()));
	}

	public boolean isPushed() throws DataPointException, AccessException {
		return pushed.getValue();
	}

}