summaryrefslogtreecommitdiff
path: root/SA_POP/SA_POP_Exceptions.h
blob: 6bc69e8f97872298e203e65280663d288edfbda8 (plain)
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
// -*- C++ -*-
// $Id$

//=============================================================================
/**
 * @file  SA_POP_Exceptions.h
 *
 * This file contains the class definitions for SA-POP exceptions.
 *
 * @author  John S. Kinnebrew <john.s.kinnebrew@vanderbilt.edu>
 */
//=============================================================================

#ifndef SA_POP_EXCEPTIONS_H_
#define SA_POP_EXCEPTIONS_H_

#include <stdexcept>
#include <string>
#include "SA_POP_Types.h"

namespace SA_POP {

  /**
   * @class InvalidTask
   *
   * @brief Class for invalid task id argument exceptions.
   */
  class InvalidTask : public std::invalid_argument {
  public:
    /// Default constructor.
    InvalidTask (void);

    /// Constructor with task id info for exception message.
    /**
     * @param task_id  Invalid task id.
     */
    InvalidTask (TaskID task_id);

    /// Destructor.
    virtual ~InvalidTask (void) throw ();

    /// Create exception message string.
    /**
     * @param task_id  Invalid task id.
     *
     * @return  Exception message string.
     */
    std::string create_msg (TaskID task_id);
  };

  /**
   * @class DuplicateTask
   *
   * @brief Class for duplicate task id argument exceptions.
   */
  class DuplicateTask : public std::invalid_argument {
  public:
    /// Default constructor.
    DuplicateTask (void);

    /// Constructor with task id info for exception message.
    /**
     * @param task_id  Duplicate task id.
     */
    DuplicateTask (TaskID task_id);

    /// Destructor.
    virtual ~DuplicateTask (void) throw ();

    /// Create exception message string.
    /**
     * @param task_id  Duplicate task id.
     *
     * @return  Exception message string.
     */
    std::string create_msg (TaskID task_id);
  };

  /**
   * @class DuplicateCond
   *
   * @brief Class for duplicate condition id argument exceptions.
   */
  class DuplicateCond : public std::invalid_argument {
  public:
    /// Default constructor.
    DuplicateCond (void);

    /// Constructor with condition id info for exception message.
    /**
     * @param cond_id  Duplicate condition id.
     */
    DuplicateCond (CondID cond_id);

    /// Destructor.
    virtual ~DuplicateCond (void) throw ();

    /// Create exception message string.
    /**
     * @param cond_id  Duplicate condition id.
     *
     * @return  Exception message string.
     */
    std::string create_msg (CondID cond_id);
  };

  /**
   * @class InvalidCond
   *
   * @brief Class for invalid condition id argument exceptions.
   */
  class InvalidCond : public std::invalid_argument {
  public:
    /// Default constructor.
    InvalidCond (void);

    /// Constructor with condition id info for exception message.
    /**
     * @param cond_id  Invalid condition id.
     */
    InvalidCond (CondID cond_id);

    /// Destructor.
    virtual ~InvalidCond (void) throw ();

    /// Create exception message string.
    /**
     * @param cond_id  Duplicate condition id.
     *
     * @return  Exception message string.
     */
    std::string create_msg (CondID cond_id);
  };

  /**
   * @class Uninitialized
   *
   * @brief Class for exceptions an object being used before being initialized.
   */
  class Uninitialized : public std::logic_error {
  public:
    /// Default constructor.
    Uninitialized (void);

    /// Constructor with exception message.
    /**
     * @param msg  Exception message.
     */
    Uninitialized (std::string msg);

    /// Destructor.
    virtual ~Uninitialized (void) throw ();
  };

};  /* SA_POP namespace */

#endif /* SA_POP_EXCEPTIONS_H_ */