osd-contiki/tools/cooja/apps/mrm/java/se/sics/mrm/RayData.java

/*
 * Copyright (c) 2006, Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Institute nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $Id: RayData.java,v 1.2 2007/03/23 21:13:43 fros4943 Exp $
 */

package se.sics.mrm;

import java.awt.geom.Line2D;
import java.awt.geom.Point2D;

/**
 * @author Fredrik Osterlind
 */
class RayData {
  
  enum RayType { ORIGIN, REFRACTION, REFLECTION, DIFFRACTION, DESTINATION }
  RayType type;
  
  private Point2D sourcePoint = null;
  private Line2D line = null;

  private int limitOverall = 0;
  private int limitRefracted = 0;
  private int limitReflected = 0;
  private int limitDiffracted = 0;

  /**
   * Creates a new ray data instance.
   * A ray can be of the following types:
   * 
   *  ORIGIN - starting at source point, line should be null
   *  REFRACTED - ray was refracted at an obstacle, 
   *   source is intersection point with obstacle, line should be null
   *  REFLECTED - an interval of rays is reflected at given line,
   *   the source point should be a "psuedo-source" is located behind it
   *   (as if one was looking from given source point through given line)
   *  DIFFRACTED - a ray is diffracted at given source point,
   *   line should be null
   *  DESTINATION
   * @param type Type of ray (one of the above)
   * @param sourcePoint See above
   * @param line See above (may be null)
   * @param limitOverall Maximum numbers of sub rays this ray may produce
   * @param limitRefracted Maximum numbers of refracted sub rays this ray may produce
   * @param limitReflected Maximum numbers of reflected sub rays this ray may produce
   * @param limitDiffracted Maximum numbers of diffracted sub rays this ray may produce
   */
  public RayData(
      RayType type,
      Point2D sourcePoint,
      Line2D line,
      int limitOverall,
      int limitRefracted,
      int limitReflected,
      int limitDiffracted
  ) {
    this.type = type;
    this.sourcePoint = sourcePoint;
    this.line = line;
    this.limitOverall = limitOverall;
    this.limitRefracted = limitRefracted;
    this.limitReflected = limitReflected;
    this.limitDiffracted = limitDiffracted;
  }
  
  public RayType getType() {
    return type;
  }
  
  public Point2D getSourcePoint() {
    return sourcePoint;
  }

  public Line2D getLine() {
    return line;
  }

  public int getSubRaysLimit() {
    return Math.min(limitOverall, limitRefracted + limitReflected + limitDiffracted);
  }
  
  public int getRefractedSubRaysLimit() {
    return Math.min(limitOverall, limitRefracted);
  }
  
  public int getReflectedSubRaysLimit() {
    return Math.min(limitOverall, limitReflected);
  }
  
  public int getDiffractedSubRaysLimit() {
    return Math.min(limitOverall, limitDiffracted);
  }
  
}