org.eclipse.om2m.sdt/org.eclipse.om2m.sdt.home/src/main/java/org/eclipse/om2m/sdt/home/modules/DoorStatus.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.datapoints.StringDataPoint;
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.DoorState;
import org.eclipse.om2m.sdt.home.types.ModuleType;

public class DoorStatus extends Module {
	
	private DoorState doorState;
	
	private StringDataPoint openDuration;
	
	private BooleanDataPoint openAlarm;
	
	
	public DoorStatus(final String name, final Domain domain, DoorState state) {
		super(name, domain, ModuleType.doorStatus);

		if ((state == null) ||
				! state.getShortName().equals(DatapointType.doorState.getShortName())) {
			domain.removeModule(getName());
			throw new IllegalArgumentException("Wrong doorState datapoint: " + state);
		}
		this.doorState = state;
		this.doorState.setWritable(false);
		this.doorState.setDoc("\"True\" indicates that door is closed, \"False\"indicates the door is open.");
		addDataPoint(this.doorState);
	}
	
	public DoorStatus(final String name, final Domain domain, Map<String, DataPoint> dps) {
		this(name, domain, (DoorState) dps.get(DatapointType.doorState.getShortName()));
		StringDataPoint openDuration = (StringDataPoint) dps.get(DatapointType.openDuration.getShortName());
		if (openDuration != null)
			setOpenDuration(openDuration);
		BooleanDataPoint openAlarm = (BooleanDataPoint) dps.get(DatapointType.openAlarm.getShortName());
		if (openAlarm != null)
			setOpenAlarm(openAlarm);
	}

	public DoorState.Values getDoorState() throws DataPointException, AccessException {
		return doorState.getValue();
	}

	public void setOpenDuration(StringDataPoint dp) {
		this.openDuration = dp;
		this.openDuration.setOptional(true);
		this.openDuration.setWritable(false);
		this.openDuration.setDoc("The time duration the door has been open. The type of openDuration is an ISO 8601 Time encoded string.");
		addDataPoint(openDuration);
	}

	public String getOpenDuration() throws DataPointException, AccessException {
		if (openDuration == null)
			throw new DataPointException("Not implemented");
		return openDuration.getValue();
	}

	public void setOpenAlarm(BooleanDataPoint dp) {
		this.openAlarm = dp;
		this.openAlarm.setOptional(true);
		this.openAlarm.setWritable(true);
		this.openAlarm.setDoc("The state of the door open alarm. True indicates that the open alarm is active. False indicates that open alarm is not active.");
		addDataPoint(openAlarm);
	}

	public boolean getOpenAlarm() throws DataPointException, AccessException {
		if (openAlarm == null)
			throw new DataPointException("Not implemented");
		return openAlarm.getValue();
	}

	public void setOpenAlarm(boolean b) throws DataPointException, AccessException {
		if (openAlarm == null)
			throw new DataPointException("Not implemented");
		this.openAlarm.setValue(b);
	}

}