Isis Developer Reference
Message.h
Go to the documentation of this file.
1 #ifndef Message_h
2 #define Message_h
3 
9 #include <QString>
10 #include <vector>
11 
12 namespace Isis {
13  /* Documentation for this namespace is in:
14  * isis/src/docsys/Object/build/isisDoxyDefs.doxydef
15  * @internal
16  * @history 2016-08-28 Kelvin Rodriguez - Moved 'using namespace' to be properly defined
17  * after the includes for every cpp file in the message folder.
18  * Part of porting to OS X 10.11.
19  */
20  namespace Message {
30  QString ArraySubscriptNotInRange(int index);
31 
42  QString KeywordAmbiguous(const QString &key);
43 
53  QString KeywordUnrecognized(const QString &key);
54 
64  QString KeywordDuplicated(const QString &key);
65 
75  QString KeywordNotArray(const QString &key);
76 
86  QString KeywordNotFound(const QString &key);
87 
96  QString KeywordBlockInvalid(const QString &block);
97 
107  QString KeywordBlockStartMissing(const QString &block, const QString &found);
108 
118  QString KeywordBlockEndMissing(const QString &block, const QString &found);
119 
129  QString KeywordValueBad(const QString &key);
130 
141  QString KeywordValueBad(const QString &key, const QString &value);
142 
152  QString KeywordValueExpected(const QString &key);
153 
166  QString KeywordValueNotInRange(const QString &key, const QString &value,
167  const QString &range);
168 
180  QString KeywordValueNotInList(const QString &key, const QString &value,
181  const std::vector<QString> &list);
182 
191  QString MissingDelimiter(const char delimiter);
192 
202  QString MissingDelimiter(const char delimiter, const QString &near);
203 
212  QString FileOpen(const QString &filename);
213 
222  QString FileCreate(const QString &filename);
223 
232  QString FileRead(const QString &filename);
233 
242  QString FileWrite(const QString &filename);
243 
251  QString MemoryAllocationFailed();
252  }
253 }
254 
255 #endif
Isis::Message::KeywordUnrecognized
QString KeywordUnrecognized(const QString &key)
This error should be used when a supplied keyword for an Isis application parameter does not match an...
Definition: KeywordUnrecognized.cpp:12
Isis::Message::KeywordBlockEndMissing
QString KeywordBlockEndMissing(const QString &block, const QString &found)
This error has been deprecated and should not be used in new code.
Definition: KeywordBlockEndMissing.cpp:11
Isis::Message::KeywordValueExpected
QString KeywordValueExpected(const QString &key)
This error should be used when the value of a supplied keyword was expected but not present.
Definition: KeywordValueExpected.cpp:12
Isis::Message::FileOpen
QString FileOpen(const QString &filename)
This error should be used when a file could not be opened.
Definition: FileOpen.cpp:11
Isis::Message::MemoryAllocationFailed
QString MemoryAllocationFailed()
This error should be used when an error accrues during a memory allocation such as "new".
Definition: MemoryAllocationFailed.cpp:12
Isis::Message::KeywordBlockStartMissing
QString KeywordBlockStartMissing(const QString &block, const QString &found)
This error has been deprecated and should not be used in new code.
Definition: KeywordBlockStartMissing.cpp:12
Isis::Message::KeywordValueBad
QString KeywordValueBad(const QString &key)
This error should be used when a supplied keyword does not appear in the list (e.g....
Definition: KeywordValueBad.cpp:11
Isis::Message::KeywordNotFound
QString KeywordNotFound(const QString &key)
This error should be used when a supplied keyword is not defined in the application.
Definition: KeywordNotFound.cpp:12
Isis::Message::KeywordNotArray
QString KeywordNotArray(const QString &key)
This error should be used when a supplied keyword is being used as an array (i.e.,...
Definition: KeywordNotArray.cpp:12
Isis::toString
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
IString.h
Isis::Message::KeywordValueNotInList
QString KeywordValueNotInList(const QString &key, const QString &value, const std::vector< QString > &list)
This error should be used when the value of a supplied keyword is not one of a specific list of possi...
Isis::Message::FileRead
QString FileRead(const QString &filename)
This error should be used when an error accrues during a read of a file.
Definition: FileRead.cpp:12
Isis::Message::KeywordBlockInvalid
QString KeywordBlockInvalid(const QString &block)
This error has been deprecated and should not be used in new code.
Definition: KeywordBlockInvalid.cpp:12
Isis::Message::FileCreate
QString FileCreate(const QString &filename)
This error should be used when a file could not be created.
Definition: FileCreate.cpp:12
Isis::Message::KeywordAmbiguous
QString KeywordAmbiguous(const QString &key)
This error should be used when a supplied keyword for an Isis application parameter does not contain ...
Definition: KeywordAmbiguous.cpp:11
std
Namespace for the standard library.
Isis::Message::MissingDelimiter
QString MissingDelimiter(const char delimiter)
This error should be used when a delimiter is missing.
Definition: MissingDelimiter.cpp:15
Isis::Message::FileWrite
QString FileWrite(const QString &filename)
This error should be used when an error accrues during a write to a file.
Definition: FileWrite.cpp:11
Isis::Message::KeywordDuplicated
QString KeywordDuplicated(const QString &key)
This error should be used when a supplied keyword for an Isis application parameter is the same as on...
Definition: KeywordDuplicated.cpp:12
Isis::Message::ArraySubscriptNotInRange
QString ArraySubscriptNotInRange(int index)
This error should be used when an Isis object or application is checking array bounds and the legal r...
Definition: ArraySubscriptNotInRange.cpp:31
Isis::Message::KeywordValueNotInRange
QString KeywordValueNotInRange(const QString &key, const QString &value, const QString &range)
This error should be used when the value of a supplied keyword is not within a specific range.
Definition: KeywordValueNotInRange.cpp:12
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Message.h