[Jmri-commits] jmri/jmrix/ecos EcosPreferences.java,NONE,1.1

[Kevin D. <kev...@us...>]

Update of /cvsroot/jmri/jmri/jmrix/ecos
In directory fdv4jf1.ch3.sourceforge.com:/tmp/cvs-serv718

Added Files:
	EcosPreferences.java 
Log Message:
Handles storing user preferences when dealing with syncronising data with between the ecos and jmri

--- NEW FILE: EcosPreferences.java ---
// EcosPreferences.java

package jmri.jmrix.ecos;

/**
 * Stores User Preferences on how to deal with syncronising the Ecos Database
 * with JMRI.
 *
 * @author	Kevin Dickerson  Copyright (C) 2009
 * @version     $Revision: 1.1 $
 */

public class EcosPreferences {
 
    public void EcosPreferences(){
	_instance = this;
    }
    //protected static boolean _addlocotoecos = false;
    

    
     /**
     * Stores the users preferance for when a loco is created in the Roster it is also
     * created in the ECOS, if it does not exist.
     * Currently not implemented.
     * @return true if the user has set it to be added
     */
     
    protected static boolean _addlocotoecos = false;
    
    public boolean getAddLocoToEcos(){
        return _addlocotoecos;
    }
    
    public void setAddLocoToEcos(boolean boo){
        _addlocotoecos = boo;
    }

     /**
     * Stores the users preferance if a loco has been created on the Ecos,
     * should an entry in the JMRI Roster be created.
     * Currently not implemented.
     * @return true if the user has set it to be added
     */
     
    protected static boolean _addlocotojmri = false;
    
    public boolean getAddLocoToJMRI(){
        return _addlocotojmri;
    }
    
    public void setAddLocoToJMRI(boolean boo){
        _addlocotojmri = boo;
    }
    
     /**
     * Stores the users preferance on how the ecos loco description,
     * should be formated.
     * @return A user configured string.
     */    
    
    protected static String _ecoslocodescription = null;
    
    public String getEcosLocoDescription(){
        return _ecoslocodescription;
    }
    
    public void setEcosLocoDescription(String descript){
        _ecoslocodescription = descript;
    }
    
     /**
     * If there is a conflict in loco information between the Ecos and JMRI,
     * this determines which system wins.
     * Currently not implemented.
     * @return 0x00 NOSYNC, 0x01 WARN, 0x02 JMRI Wins, 0x03 ECOS Wins.
     */
     
    private static final int NOSYNC     = 0x00;
    private static final int WARN       = 0x01;
    private static final int JMRI       = 0x02;
    private static final int ECOS       = 0x03;
    
    protected static int _locomaster = 0x00;
    
    public int getLocoMaster(){
        return _locomaster;
    }
    
    public void setLocoMaster(int master){
        _locomaster = master;
    }
    
    public void setLocoMaster(String master){
        if (master.equals("NOSYNC")) _locomaster = 0x00;
        else if (master.equals("WARN")) _locomaster = 0x01;
        else if (master.equals("JMRI")) _locomaster = 0x02;
        else if (master.equals("ECOS")) _locomaster = 0x03;
        else _locomaster = 0x00;
    }
    
    public String getLocoMasterAsString(){
        String result;
        switch(_locomaster){
            case 0x00 : result = "NOSYNC"; break;
            case 0x01 : result = "WARN"; break;
            case 0x02 : result = "JMRI"; break;
            case 0x03 : result = "ECOS"; break;
            default : result = "NOSYNC"; break;
            }
        return result;
    }
 
    /**
    * Stores the users preferance if a loco has been created ad-hoc,
    * on the Throttle, should the entry created for it in the ECOS be deleted.
    * Currently not implemented.
    * @return 0x00 if the user has not set a remember this value
    * 0x01 if the user sets the preference to always leave the loco from the Ecos when finished.
    * 0x02 if the user sets the preference to always remove the loco on the Ecos when finished.
    */
     
    protected static int _adhoclocofromecos = 0x00;
     
    public int getAdhocLocoFromEcos(){
        return _adhoclocofromecos;
    }
    
    public void setAdhocLocoFromEcos(int boo){
        _adhoclocofromecos = boo;
    }
    
    /**
    * Stores the users preferance as to whether the setting _removeadhoclocofromecos,
    * should be used all the time
    * Currently not implemented.
    * @return true if the user has set it to be added
    */
     
    /*protected static boolean _rememberadhoclocofromecos = false;
     
    public boolean getRememberAdhocLocoFromEcos(){
        return _rememberadhoclocofromecos;
    }
    
    public void setRememberAdhocLocoFromEcos(boolean boo){
        _rememberadhoclocofromecos = boo;
    }
    */
    /**
    * Stores the users preferance for deleting a loco from the roster should it,
    * also be deleted from the ECOS.
    * Currently not implemented.
    * @return true if the user has set it to be added
    */
      
    protected static boolean _removelocofromecos = false;
    
    public boolean getRemoveLocoFromEcos(){
        return _removelocofromecos;
    }
    
    public void setRemoveLocoFromEcos(boolean boo){
        _removelocofromecos = boo;
    }
    
    /**
    * Stores the users preferance for deleting a loco from the ECOS should it,
    * also be deleted from the JMRI Roster.
    * Currently not implemented.
    * @return true if the user has set it to be added
    */
    
    protected static boolean _removelocofromjmri = false;

    public boolean getRemoveLocoFromJMRI(){
        return _removelocofromjmri;
    }
    
    public void setRemoveLocoFromJMRI(boolean boo){
        _removelocofromjmri = boo;
    }

    /**
    * Stores the users preferance when creating a turnout in JMRI should it
    * also be created on the ECOS.
    * Currently not implemented.
    * @return true if the user has set it to be added
    */    
    protected static boolean _addturnoutstoecos = false;
    
    public boolean getAddTurnoutsToEcos(){
        return _addturnoutstoecos;
    }
    
    public void setAddTurnoutsToEcos(boolean boo){
        _addturnoutstoecos = boo;
    }
    
    /**
    * Stores the users preferance when a new turnout is created on the ECOS should it
    * also be created in JMRI.
    * Currently not implemented.
    * @return true if the user has set it to be added
    */
    
    protected static boolean _addturnoutstojmri = false;

    public boolean getAddTurnoutsToJMRI(){
        return _addturnoutstojmri;
    }
    
    public void setAddTurnoutsToJMRI(boolean boo){
        _addturnoutstojmri = boo;
    }

    /**
    * Stores the users preferance when a new turnout is removed from the ECOS should it
    * also be removed from JMRI..
    * Currently not implemented.
    * @return true if the user has set it to be added
    */
    
    protected static boolean _removeturnoutsfromjmri = false;

    public boolean getRemoveTurnoutsFromJMRI(){
        return _removeturnoutsfromjmri;
    }
    
    public void setRemoveTurnoutsFromJMRI(boolean boo){
        _removeturnoutsfromjmri = boo;
    }
    
    /**
    * Stores the users preferance when a new turnout is removed from JMRI should it
    * also be removed from the ECOS.
    * Currently not implemented.
    * @return true if the user has set it to be added
    */    
    protected static boolean _removeturnoutsfromecos = false;
    
    public boolean getRemoveTurnoutsFromEcos(){
        return _removeturnoutsfromecos;
    }
    
    public void setRemoveTurnoutsFromEcos(boolean boo){
        _removeturnoutsfromecos = boo;
    }
    public void setInstance(){

    }
    public String name(){
        return null;
    }
    static public EcosPreferences instance() {
       if (_instance == null) _instance = new EcosPreferences();
        return _instance; 
       /* if (_instance == null){
            _instance = new EcosPreferences();
            jmri.InstanceManager.configureManagerInstance().registerPref(_instance);
        }
        return _instance;*/
    }
    static EcosPreferences _instance = null;

 }