|
Isis 3.0 Object Programmers' Reference |
Home |
Namespace containing standardized Isis error messages. More...
Functions | |
| QString | ArraySubscriptNotInRange (int index) |
| This error should be used when an Isis object or application is checking array bounds and the legal range has been violated. | |
| QString | KeywordAmbiguous (const QString &key) |
| This error should be used when a supplied keyword for an Isis application parameter does not contain enough characters to distinguish it from another keyword. | |
| QString | KeywordUnrecognized (const QString &key) |
| This error should be used when a supplied keyword for an Isis application parameter does not match any of the parameters for that application. | |
| QString | KeywordDuplicated (const QString &key) |
| This error should be used when a supplied keyword for an Isis application parameter is the same as one previously supplied. | |
| QString | KeywordNotArray (const QString &key) |
| This error should be used when a supplied keyword is being used as an array (i.e., with a subscript) but is only a scaler entity. | |
| QString | KeywordNotFound (const QString &key) |
| This error should be used when a supplied keyword is not defined in the application. | |
| QString | KeywordBlockInvalid (const QString &block) |
| This error has been deprecated and should not be used in new code. | |
| QString | KeywordBlockStartMissing (const QString &block, const QString &found) |
| This error has been deprecated and should not be used in new code. | |
| QString | KeywordBlockEndMissing (const QString &block, const QString &found) |
| This error has been deprecated and should not be used in new code. | |
| QString | KeywordValueBad (const QString &key) |
| This error should be used when a supplied keyword does not appear in the list (e.g., an Isis cube label). | |
| QString | KeywordValueBad (const QString &key, const QString &value) |
| This error should be used when the value of a supplied keyword is incorrect. | |
| QString | KeywordValueExpected (const QString &key) |
| This error should be used when the value of a supplied keyword was expected but not present. | |
| 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. | |
| 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 possible values. | |
| QString | MissingDelimiter (const char delimiter) |
| This error should be used when a delimiter is missing. | |
| QString | MissingDelimiter (const char delimiter, const QString &near) |
| This error should be used when a delimiter is missing. | |
| QString | FileOpen (const QString &filename) |
| This error should be used when a file could not be opened. | |
| QString | FileCreate (const QString &filename) |
| This error should be used when a file could not be created. | |
| QString | FileRead (const QString &filename) |
| This error should be used when an error accrues during a read of a file. | |
| QString | FileWrite (const QString &filename) |
| This error should be used when an error accrues during a write to a file. | |
| QString | MemoryAllocationFailed () |
| This error should be used when an error accrues during a memory allocation such as "new". | |
Namespace containing standardized Isis error messages.
IsisMessage is not a class. It only contains a namespace which consists of all the standardized Isis error messages. These messages should be used when applicable instead of constructing the message string inside the object or application.
| QString Isis::Message::ArraySubscriptNotInRange | ( | int | index | ) |
This error should be used when an Isis object or application is checking array bounds and the legal range has been violated.
| index | - Array index which is out of bounds |
Definition at line 31 of file ArraySubscriptNotInRange.cpp.
References Isis::toString().
Referenced by Isis::Buffer::at(), Isis::Histogram::BinCount(), Isis::Histogram::BinMiddle(), Isis::Histogram::BinRange(), Isis::PvlKeyword::Comment(), Isis::PvlToken::GetValue(), Isis::PvlToken::GetValueUpper(), Isis::PvlObject::Group(), Isis::Buffer::Index(), Isis::PvlKeyword::IsEquivalent(), Isis::PvlKeyword::IsNull(), Isis::PvlObject::Object(), Isis::PvlContainer::operator[](), Isis::PvlKeyword::operator[](), and Isis::PvlKeyword::Unit().
| QString Isis::Message::FileCreate | ( | const QString & | filename | ) |
This error should be used when a file could not be created.
| filename | - The name of the file |
Definition at line 28 of file FileCreate.cpp.
Referenced by Isis::Pvl::Write().
| QString Isis::Message::FileOpen | ( | const QString & | filename | ) |
This error should be used when a file could not be opened.
| filename | - The name of the file |
Definition at line 28 of file FileOpen.cpp.
Referenced by Isis::Pvl::Append(), Isis::Application::Application(), Isis::FileList::read(), Isis::Blob::Read(), Isis::Pvl::Read(), and Isis::FileList::write().
| QString Isis::Message::FileRead | ( | const QString & | filename | ) |
This error should be used when an error accrues during a read of a file.
| filename | - The name of the file |
Definition at line 28 of file FileRead.cpp.
| QString Isis::Message::FileWrite | ( | const QString & | filename | ) |
This error should be used when an error accrues during a write to a file.
| filename | - The name of the file |
Definition at line 28 of file FileWrite.cpp.
| QString Isis::Message::KeywordAmbiguous | ( | const QString & | key | ) |
This error should be used when a supplied keyword for an Isis application parameter does not contain enough characters to distinguish it from another keyword.
| key | - The name of the keyword which is ambiguous |
Definition at line 30 of file KeywordAmbiguous.cpp.
| QString Isis::Message::KeywordBlockEndMissing | ( | const QString & | block, |
| const QString & | found | ||
| ) |
This error has been deprecated and should not be used in new code.
| block | - The name of the block with the missing end tag |
| found | - The QString found in the place of the missing block end |
Definition at line 28 of file KeywordBlockEndMissing.cpp.
| QString Isis::Message::KeywordBlockInvalid | ( | const QString & | block | ) |
This error has been deprecated and should not be used in new code.
| block | - The name of the invalid keyword block |
Definition at line 28 of file KeywordBlockInvalid.cpp.
| QString Isis::Message::KeywordBlockStartMissing | ( | const QString & | block, |
| const QString & | found | ||
| ) |
This error has been deprecated and should not be used in new code.
| block | - The name of the block with the missing start tag |
| found | - The QString found in the place of the missing block start |
Definition at line 28 of file KeywordBlockStartMissing.cpp.
| QString Isis::Message::KeywordDuplicated | ( | const QString & | key | ) |
This error should be used when a supplied keyword for an Isis application parameter is the same as one previously supplied.
| key | - The name of the keyword which has been duplicated |
Definition at line 28 of file KeywordDuplicated.cpp.
| QString Isis::Message::KeywordNotArray | ( | const QString & | key | ) |
This error should be used when a supplied keyword is being used as an array (i.e., with a subscript) but is only a scaler entity.
| key | - The name of the keyword which is not an array |
Definition at line 28 of file KeywordNotArray.cpp.
| QString Isis::Message::KeywordNotFound | ( | const QString & | key | ) |
This error should be used when a supplied keyword is not defined in the application.
| key | - The name of the keyword which was not found |
Definition at line 28 of file KeywordNotFound.cpp.
| QString Isis::Message::KeywordUnrecognized | ( | const QString & | key | ) |
This error should be used when a supplied keyword for an Isis application parameter does not match any of the parameters for that application.
| key | - The name of the keyword which is unrecognized |
Definition at line 28 of file KeywordUnrecognized.cpp.
| QString Isis::Message::KeywordValueBad | ( | const QString & | key | ) |
This error should be used when a supplied keyword does not appear in the list (e.g., an Isis cube label).
| key | - The name of the keyword which is bad |
Definition at line 28 of file KeywordValueBad.cpp.
Referenced by Isis::PvlTokenizer::Load().
| QString Isis::Message::KeywordValueBad | ( | const QString & | key, |
| const QString & | value | ||
| ) |
This error should be used when the value of a supplied keyword is incorrect.
| key | - The keyword name which is bad |
| value | - The value of the keyword which is bad |
Definition at line 32 of file KeywordValueBad.cpp.
| QString Isis::Message::KeywordValueExpected | ( | const QString & | key | ) |
This error should be used when the value of a supplied keyword was expected but not present.
| key | - The keyword name which is bad |
Definition at line 28 of file KeywordValueExpected.cpp.
| QString Isis::Message::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 possible values.
| key | - The keyword name which has a bad value |
| value | - The value of the keyword |
| list | - A vector of all the legal values for the keyword |
| QString Isis::Message::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.
| key | - The keyword name which has a bad value |
| value | - The value of the keyword |
| range | - The minimum and maximum allowed values for the keyword formatted and inserted into a QString |
Definition at line 28 of file KeywordValueNotInRange.cpp.
| QString Isis::Message::MemoryAllocationFailed | ( | ) |
This error should be used when an error accrues during a memory allocation such as "new".
Definition at line 5 of file MemoryAllocationFailed.cpp.
Referenced by Isis::Buffer::Allocate().
| QString Isis::Message::MissingDelimiter | ( | const char | delimiter | ) |
This error should be used when a delimiter is missing.
| delimiter | - The delimiter that is missing |
Definition at line 8 of file MissingDelimiter.cpp.
References Isis::toString().
| QString Isis::Message::MissingDelimiter | ( | const char | delimiter, |
| const QString & | near | ||
| ) |
This error should be used when a delimiter is missing.
| delimiter | - The delimiter that is missing |
| near | - The value the missing delimiter is near |
Definition at line 12 of file MissingDelimiter.cpp.
References Isis::toString().