source: trunk/src/core/RpNumber.cc @ 1006

/*
 * ----------------------------------------------------------------------
 *  Rappture 2.0 Number Object Source
 *
 * ======================================================================
 *  AUTHOR:  Derrick Kearney, Purdue University
 *  Copyright (c) 2004-2005  Purdue Research Foundation
 *
 *  See the file "license.terms" for information on usage and
 *  redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 * ======================================================================
 */

#include "RpNumber.h"

/**********************************************************************/
// METHOD: setDefaultValue()
/// set the default value of a RpNumber object.
/**
 */

RpNumber&
RpNumber::setDefaultValue(double newDefaultVal) {

    double* def = NULL;

    def = (double*) RpVariable::getDefaultValue(); 

    if (!def) {
        RpVariable::setDefaultValue(new double (newDefaultVal));
    }
    else {
        *def = newDefaultVal;
    }

    return *this;
}

/**********************************************************************/
// METHOD: setCurrentValue()
/// Set the current value of a RpNumber object.
/**
 */

RpNumber&
RpNumber::setCurrentValue(double newCurrentVal) {

    double* cur = (double*) RpVariable::getCurrentValue();
    double* def = (double*) RpVariable::getDefaultValue();

    if (cur == def) {
        RpVariable::setCurrentValue(new double (newCurrentVal));
    }
    else {
        *cur = newCurrentVal;
    }

    return *this;
}


/**********************************************************************/
// METHOD: setMin()
/// Set the min value of a RpNumber object.
/**
 */

RpNumber&
RpNumber::setMin(double newMin) {

    min = newMin;
    return *this;
}

/**********************************************************************/
// METHOD: setMax()
/// set the min value of a RpNumber object
/**
 */

RpNumber&
RpNumber::setMax(double newMax) {

    max = newMax;
    return *this;
}

/**********************************************************************/
// METHOD: getUnits()
/// Report the units of the object.
/**
 */

std::string 
RpNumber::getUnits() const {

    return units->getUnitsName(); 
}


/**********************************************************************/
// METHOD: getDefaultValue()
/// Report the default value of the object.
/**
 */

double
RpNumber::getDefaultValue(void* null_val) const {

    return *((double*) RpVariable::getDefaultValue()); 
}

/**********************************************************************/
// METHOD: getCurrentValue()
/// Report the current value of the object.
/**
 */

double
RpNumber::getCurrentValue(void* null_val) const {

    return *((double*) RpVariable::getCurrentValue()); 
}

/**********************************************************************/
// METHOD: getMin()
/// Report the min of the object.
/**
 */

double
RpNumber::getMin() const {

    return min;
}

/**********************************************************************/
// METHOD: getMax()
/// report the max of the object.
/**
 */

double
RpNumber::getMax() const {

    return max;
}

/**********************************************************************/
// METHOD: convert()
/// Convert the number object to another unit from string
/**
 * Store the result as the currentValue.
 */

double
RpNumber::convert(std::string toUnitStr, int storeResult, int* result) {

    const RpUnits* toUnit = NULL;
    double retVal = 0;
    int my_result = 0;

    toUnit = RpUnits::find(toUnitStr);

    // set the result to the default value if it exists
    if (result) {
        *result = my_result;
    }

    if (!toUnit) {
        // should raise error! 
        // conversion not defined because unit does not exist
        return retVal;
    }

    // perform the conversion
    retVal = convert(toUnit,&my_result); 

    // check the result of the conversion and store if necessary
    if (my_result) {
        if (result) {
            *result = my_result;
        }

        // check if we should store the value and change units
        if (storeResult) {
            // no need to deallocate old units, 
            // because they are stored in static dictionary
            units = toUnit;
            RpNumber::setCurrentValue(retVal);
        }
    }

    return retVal;
}

/**********************************************************************/
// METHOD: convert()
/// Convert the number object to another unit from string.
/**
 */

double
RpNumber::convert(std::string toUnitStr, int* result) {

    const RpUnits* toUnit = NULL;
    toUnit = RpUnits::find(toUnitStr);
    if (!toUnit) {
        // should raise error! 
        // conversion not defined because unit does not exist
        if (result) {
            *result = -1;
        }
        return 0.0;
    }
    return convert(toUnit, result); 
}

/**********************************************************************/
// METHOD: convert()
/// Convert the number object to another unit from RpUnits object.
/**
 */

double
RpNumber::convert(const RpUnits* toUnit, int *result) {

    return units->convert(toUnit,getCurrentValue(), result); 
}

/**********************************************************************/
// METHOD: put()
/// Store the information of this Rappture Object into the xml
/**
 */
//
//RpNumber&
//RpNumber::put() const {
//
//    
//    return *this; 
//}


// -------------------------------------------------------------------- //