|
Isis 3.0 Object Programmers' Reference |
Home |
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.
Functions | |
| string | ArraySubscriptNotInRange (const int index) |
| This error should be used when an Isis object or application is checking array bounds and the legal range has been violated. | |
| string | FileCreate (const string &filename) |
| This error should be used when a file could not be created. | |
| string | FileOpen (const string &filename) |
| This error should be used when a file could not be opened. | |
| string | FileRead (const string &filename) |
| This error should be used when an error accrues during a read of a file. | |
| string | FileWrite (const string &filename) |
| This error should be used when an error accrues during a write to a file. | |
| string | KeywordAmbiguous (const string &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. | |
| string | KeywordBlockEndMissing (const string &block, const string &found) |
| This error has been deprecated and should not be used in new code. | |
| string | KeywordBlockInvalid (const string &block) |
| This error has been deprecated and should not be used in new code. | |
| string | KeywordBlockStartMissing (const string &block, const string &found) |
| This error has been deprecated and should not be used in new code. | |
| string | KeywordDuplicated (const string &key) |
| This error should be used when a supplied keyword for an Isis application parameter is the same as one previously supplied. | |
| string | KeywordNotArray (const string &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. | |
| string | KeywordNotFound (const string &key) |
| This error should be used when a supplied keyword is not defined in the application. | |
| string | KeywordUnrecognized (const string &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. | |
| string | KeywordValueBad (const string &key) |
| This error should be used when a supplied keyword does not appear in the list (e.g., an Isis cube label). | |
| string | KeywordValueBad (const string &key, const string &value) |
| This error should be used when the value of a supplied keyword is incorrect. | |
| string | KeywordValueExpected (const string &key) |
| This error should be used when the value of a supplied keyword was expected but not present. | |
| string | KeywordValueNotInList (const string &key, const string &value, const vector< string > &list) |
| This error should be used when the value of a supplied keyword is not one of a specific list of possible values. | |
| string | KeywordValueNotInRange (const string &key, const string &value, const string &range) |
| This error should be used when the value of a supplied keyword is not within a specific range. | |
| string | MemoryAllocationFailed () |
| This error should be used when an error accrues during a memory allocation such as "new". | |
| string | MissingDelimiter (const char delimiter) |
| This error should be used when a delimiter is missing. | |
| string | MissingDelimiter (const char delimiter, const string &near) |
| This error should be used when a delimiter is missing. | |
| string | MissingDelimiter (const char d) |
| This error should be used when a delimiter is missing. | |
| string | MissingDelimiter (const char d, const string &near) |
| This error should be used when a delimiter is missing. | |
| string Isis::Message::ArraySubscriptNotInRange | ( | const 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 29 of file ArraySubscriptNotInRange.cpp.
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::PvlKeyword::operator[](), Isis::PvlContainer::operator[](), and Isis::PvlKeyword::Unit().
| string Isis::Message::FileCreate | ( | const string & | 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().
| string Isis::Message::FileOpen | ( | const string & | 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::PvlTranslationTable::AddTable(), Isis::Pvl::Append(), Isis::Application::Application(), Isis::Cube::Open(), Isis::PvlTranslationTable::PvlTranslationTable(), Isis::Pvl::Read(), Isis::FileList::Read(), Isis::Blob::Read(), and Isis::FileList::Write().
| string Isis::Message::FileRead | ( | const string & | 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.
| string Isis::Message::FileWrite | ( | const string & | 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.
| string Isis::Message::KeywordAmbiguous | ( | const string & | 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.
| string Isis::Message::KeywordBlockEndMissing | ( | const string & | block, | |
| const string & | 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 string found in the place of the missing block end |
Definition at line 29 of file KeywordBlockEndMissing.cpp.
| string Isis::Message::KeywordBlockInvalid | ( | const string & | 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.
| string Isis::Message::KeywordBlockStartMissing | ( | const string & | block, | |
| const string & | 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 string found in the place of the missing block start |
Definition at line 29 of file KeywordBlockStartMissing.cpp.
| string Isis::Message::KeywordDuplicated | ( | const string & | 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.
| string Isis::Message::KeywordNotArray | ( | const string & | 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.
| string Isis::Message::KeywordNotFound | ( | const string & | 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.
| string Isis::Message::KeywordUnrecognized | ( | const string & | 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.
| string Isis::Message::KeywordValueBad | ( | const string & | 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().
| string Isis::Message::KeywordValueBad | ( | const string & | key, | |
| const string & | 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 34 of file KeywordValueBad.cpp.
| string Isis::Message::KeywordValueExpected | ( | const string & | 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.
| string Isis::Message::KeywordValueNotInList | ( | const string & | key, | |
| const string & | value, | |||
| const vector< string > & | 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 |
Definition at line 29 of file KeywordValueNotInList.cpp.
| string Isis::Message::KeywordValueNotInRange | ( | const string & | key, | |
| const string & | value, | |||
| const string & | 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 string |
Definition at line 29 of file KeywordValueNotInRange.cpp.
| string 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().
| string 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 6 of file MissingDelimiter.cpp.
Referenced by Isis::PvlTokenizer::ReadToBrace(), Isis::PvlTokenizer::ReadToDoubleQuote(), Isis::PvlTokenizer::ReadToParen(), and Isis::PvlTokenizer::ReadToSingleQuote().
| string Isis::Message::MissingDelimiter | ( | const char | delimiter, | |
| const string & | 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.
| string 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 6 of file MissingDelimiter.cpp.
| string Isis::Message::MissingDelimiter | ( | const char | delimiter, | |
| const string & | 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.