/*
!=======================================================================
!
!  PROGRAM  PHASE-Viewer  (PHASE-Viewer 2014.01 ver.3.3.0)
!
!  Created on 2005/10/06, 18:40
!  AUTHOR(S): KOGA, Junichiro
!  File : AtomEvent.java
!  
!  Contact address :  Phase System Consortium
!                     E-mail: phase_system@nims.go.jp URL https://azuma.nims.go.jp
!
!
!   Since 2002, this program set had been intensively developed as a part of the following 
!  national projects supported by the Ministry of Education, Culture, Sports, Science and
!  Technology (MEXT) of Japan; "Frontier Simulation Software for Industrial Science
!  (FSIS)" from 2002 to 2005, "Revolutionary Simulation Software (RSS21)" from 2006 to
!  2008. "Research and Development of Innovative Simulation Software (RISS)" from 2008
!  to 2013. These projects is lead by the Center for Research on Innovative Simulation 
!  Software (CISS), the Institute of Industrial Science (IIS), the University of Tokyo.
!   Since 2013, this program set has been further developed centering on PHASE System
!  Consortium. 
!   The activity of development of this program set has been supervised by Takahisa Ohno.
!
!=======================================================================
 */

package ciss.phase_viewer.atomcoord;

import org.apache.log4j.Logger;

/**
 * 原子の座標やアトリビュートなどに変更があった場合に, 必要な情報を持っているクラス.
 * 
 * @author
 */
public class AtomEvent {
    private Logger logger = Logger.getLogger(AtomEvent.class.getName());
    private Atom atom;
    private int atomIndex;

    /**
     * Creates a new instance of AtomEvent
     * 
     * @param atom
     *            変更のあったAtomオブジェクト
     * @param atomIndex
     *            atomのインデックス
     */
    public AtomEvent(Atom atom, int atomIndex) {
        this.atom = atom;
        this.atomIndex = atomIndex;
    }

    /**
     * 対応するAtomオブジェクトへの参照を返す.
     * 
     * @return 変更が施されたAtomオブジェクト.
     */
    public Atom getAtom() {
        return this.atom;
    }

    /**
     * 「何番目の原子か」を返す. 新たに足す場合, -1を返す.
     * 
     * @return 何番目の原子か. 新たに足す場合は-1.
     */
    public int getIndex() {
        return this.atomIndex;
    }

    public String toString() {
        return "atom no. " + atomIndex + " : " + atom;
    }

}
