AttributeHandle.java

/*
 * JaamSim Discrete Event Simulation
 * Copyright (C) 2014 Ausenco Engineering Canada Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.jaamsim.input;

import com.jaamsim.basicsim.Entity;

public class AttributeHandle extends OutputHandle {
	private final String attributeName;
	private ExpResult initialValue;
	private ExpResult value;

	public AttributeHandle(Entity e, String outputName) {
		super(e);
		this.attributeName = outputName;
	}

	public void setInitialValue(ExpResult val) {
		initialValue = val;
	}

	public ExpResult getInitialValue() {
		return initialValue.getCopy();
	}

	public void setValue(ExpResult val) {
		value = val;
	}

	@Override
	public <T> T getValue(double simTime, Class<T> klass) {
		if (!ent.hasAttribute(attributeName)) {
			return null;
		}
		if (value == null) {
			return null;
		}
		return value.getValue(simTime, klass);
	}

	@Override
	public double getValueAsDouble(double simTime, double def) {
		if (value.type == ExpResType.NUMBER)
			return value.value;
		else
			return def;
	}

	@Override
	public Class<?> getReturnType() {
		return ExpResult.class;
	}
	@Override
	public Class<?> getDeclaringClass() {
		return Entity.class;
	}
	@Override
	public String getDescription() {
		return "User defined attribute";
	}
	@Override
	public String getName() {
		return attributeName;
	}
	@Override
	public boolean isReportable() {
		return true;
	}
	@Override
	public int getSequence() {
		return Integer.MAX_VALUE;
	}
	@Override
	public boolean canCache() {
		return false;
	}

}