GException_model.cpp 16.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
/***************************************************************************
 *            GException_model.cpp  -  Model exception handlers            *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2010-2011 by Jurgen Knodlseder                           *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  This program is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation, either version 3 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
/**
 * @file GException_model.cpp
 * @brief Implement exceptions for the model module
 * @author J. Knodlseder
 */

/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GException.hpp"
#include "GModelRegistry.hpp"
#include "GModelSpatialRegistry.hpp"
#include "GModelSpectralRegistry.hpp"
#include "GModelTemporalRegistry.hpp"
#include "GTools.hpp"


/***********************************************************************//**
 * @brief Invalid model type
 *
 * @param[in] origin Method that throws the error.
 * @param[in] type Model type that has been encountered.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid::model_invalid(std::string origin,
                                         std::string type,
                                         std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid model type \""+type+"\" encountered. " + message;

    // Add list of valid models
    GModelRegistry registry;
    if (registry.size() > 0) {
        m_message += "The following models are registered: ";
        for (int i = 0; i < registry.size(); ++i) {
            if (i > 0)
                m_message += ", ";
            m_message += "\"" + registry.name(i) + "\"";
        }
        m_message += ".";
    }
    else
        m_message += "No models are registered.";

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid spatial model type
 *
 * @param[in] origin Method that throws the error.
 * @param[in] type Spatial model type that has been encountered.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_spatial::model_invalid_spatial(std::string origin,
                                                         std::string type,
                                                         std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid spatial model type \""+type+"\" encountered. " +
                message;

    // Add list of valid spatial models
    GModelSpatialRegistry registry;
    if (registry.size() > 0) {
        m_message += "The following models are registered: ";
        for (int i = 0; i < registry.size(); ++i) {
            if (i > 0)
                m_message += ", ";
            m_message += "\"" + registry.name(i) + "\"";
        }
        m_message += ".";
    }
    else
        m_message += "No models are registered.";

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid spectral model type
 *
 * @param[in] origin Method that throws the error.
 * @param[in] type Spectral model type that has been encountered.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_spectral::model_invalid_spectral(std::string origin,
                                                           std::string type,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid spectral model type \""+type+"\" encountered. " +
                message;

    // Add list of valid spectral models
    GModelSpectralRegistry registry;
    if (registry.size() > 0) {
        m_message += "The following models are registered: ";
        for (int i = 0; i < registry.size(); ++i) {
            if (i > 0)
                m_message += ", ";
            m_message += "\"" + registry.name(i) + "\"";
        }
        m_message += ".";
    }
    else
        m_message += "No models are registered.";

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid temporal model type
 *
 * @param[in] origin Method that throws the error.
 * @param[in] type Temporal model type that has been encountered.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_temporal::model_invalid_temporal(std::string origin,
                                                           std::string type,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid temporal model type \""+type+"\" encountered. " +
                message;

    // Add list of valid spectral models
    GModelTemporalRegistry registry;
    if (registry.size() > 0) {
        m_message += "The following models are registered: ";
        for (int i = 0; i < registry.size(); ++i) {
            if (i > 0)
                m_message += ", ";
            m_message += "\"" + registry.name(i) + "\"";
        }
        m_message += ".";
    }
    else
        m_message += "No models are registered.";

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid number of model parameters in XML element
 *
 * @param[in] origin Method that throws the error.
 * @param[in] xml XML element.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_parnum::model_invalid_parnum(std::string origin,
                                                       GXmlElement xml,
                                                       std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid number of model parameters found in XML element. " +
                message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid model parameter names in XML element
 *
 * @param[in] origin Method that throws the error.
 * @param[in] xml XML element.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_parnames::model_invalid_parnames(std::string origin,
                                                           GXmlElement xml,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid model parameter names found in XML element. " +
                message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid model parameter value in XML element
 *
 * @param[in] origin Method that throws the error.
 * @param[in] xml XML element.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_parvalue::model_invalid_parvalue(std::string origin,
                                                           GXmlElement xml,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid model parameter value found in XML element. " +
                message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid model parameter limit in XML element
 *
 * @param[in] origin Method that throws the error.
 * @param[in] xml XML element.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_parlimit::model_invalid_parlimit(std::string origin,
                                                           GXmlElement xml,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid model parameter limit found in XML element. " +
                message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Model parameter has invalid scale
 *
 * @param[in] origin Method that throws the error.
 * @param[in] scale Scale.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_parscale::model_invalid_parscale(std::string origin,
                                                           double      scale,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Model parameter has invalid scale="+gammalib::str(scale)+". " +
                message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Model parameter has invalid scale
 *
 * @param[in] origin Method that throws the error.
 * @param[in] xml XML element.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_invalid_parscale::model_invalid_parscale(std::string origin,
                                                           GXmlElement xml,
                                                           std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Model parameter with invalid scale found in XML element. " +
                message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Not enough nodes in file function
 *
 * @param[in] origin Method that throws the error.
 * @param[in] filename File function filename.
 * @param[in] num Number of nodes.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::file_function_data::file_function_data(std::string origin,
                                                   std::string filename,
                                                   int         num,
                                                   std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "File function \""+filename+"\" contains "+gammalib::str(num)+
                " energy nodes while at least 2 are required to describe a"
                " spectral shape.";
    if (message.length() > 0) {
        m_message += " "+message;
    }

    // Return
    return;
}


/***********************************************************************//**
 * @brief Not enough columns in file function
 *
 * @param[in] origin Method that throws the error.
 * @param[in] filename File function filename.
 * @param[in] num Number of columns.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::file_function_columns::file_function_columns(std::string origin,
                                                         std::string filename,
                                                         int         num,
                                                         std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "File function \""+filename+"\" contains "+gammalib::str(num)+
                " columns while at least 2 are required to define"
                " energy and intensity.";
    if (message.length() > 0) {
        m_message += " "+message;
    }

    // Return
    return;
}


/***********************************************************************//**
 * @brief Invalid value in file function
 *
 * @param[in] origin Method that throws the error.
 * @param[in] filename File function filename.
 * @param[in] value Number of columns.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::file_function_value::file_function_value(std::string origin,
                                                     std::string filename,
                                                     double      value,
                                                     std::string message)
{
    // Set origin and message
    m_origin  = origin;
    m_message = "Invalid value \""+gammalib::str(value)+"\" encountered in"
                " file function \""+filename+"\".";
    if (message.length() > 0) {
        m_message += " "+message;
    }

    // Return
    return;
}


/***********************************************************************//**
 * @brief Parameter not found
 *
 * @param[in] origin Method that throws the error.
 * @param[in] name Parameter name.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::par_not_found::par_not_found(std::string origin,
                                         std::string name,
                                         std::string message)
{
    // Set origin
    m_origin  = origin;

    // Set message
    m_message = "Parameter \""+name+"\" not found in container.";
    if (message.length() > 0)
        m_message += " "+message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Model not found
 *
 * @param[in] origin Method that throws the error.
 * @param[in] name Model name.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::model_not_found::model_not_found(std::string origin,
                                             std::string name,
                                             std::string message)
{
    // Set origin
    m_origin  = origin;

    // Set message
    m_message = "Model \""+name+"\" not found in container.";
    if (message.length() > 0)
        m_message += " "+message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief No point source model component found
 *
 * @param[in] origin Method that throws the error.
 * @param[in] name Model name.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::no_point_source::no_point_source(std::string origin,
                                             std::string name,
                                             std::string message)
{
    // Set origin
    m_origin  = origin;

    // Set message
    m_message = "No point source model component found in model \""+name+"\".";
    if (message.length() > 0)
        m_message += " "+message;

    // Return
    return;
}


/***********************************************************************//**
 * @brief No extended source model component found
 *
 * @param[in] origin Method that throws the error.
 * @param[in] name Model name.
 * @param[in] message Optional error message.
 ***************************************************************************/
GException::no_extended_source::no_extended_source(std::string origin,
                                                   std::string name,
                                                   std::string message)
{
    // Set origin
    m_origin  = origin;

    // Set message
    m_message = "No extended source model component found in model \""+name+"\".";
    if (message.length() > 0)
        m_message += " "+message;

    // Return
    return;
}