| kspaceFirstOrder3D-OMP 1.1 The C++ implementation of the k-wave toolbox for the time-domain simulation of acoustic wave fields in 3D

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

All Classes Files Functions Variables Typedefs Enumerations Friends Pages
ErrorMessages.h
Go to the documentation of this file.
1 /**
2 * @file ErrorMessages.h
3 * @author Jiri Jaros \n
4 * Faculty of Information Technology\n
5 * Brno University of Technology \n
6 * jarosjir@fit.vutbr.cz
7 *
8 * @brief The header file containing all error messages of the project.
9 *
10 * @version kspaceFirstOrder3D 2.15
11 *
12 * @date 09 August 2011, 12:34 (created) \n
13 * 29 September 2014, 14:09 (revised)
14 *
15 * @section License
16 * This file is part of the C++ extension of the k-Wave Toolbox (http://www.k-wave.org).\n
17 * Copyright (C) 2014 Jiri Jaros and Bradley Treeby
18 *
19 * This file is part of k-Wave. k-Wave is free software: you can redistribute it
20 * and/or modify it under the terms of the GNU Lesser General Public License as
21 * published by the Free Software Foundation, either version 3 of the License,
22 * or (at your option) any later version.
23 *
24 * k-Wave is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
27 * See the GNU Lesser General Public License for more details.
28 *
29 * You should have received a copy of the GNU Lesser General Public License
30 * along with k-Wave. If not, see <http://www.gnu.org/licenses/>.
31 */
32
33
34 #ifndef ERRORMESSAGES_H
35 #define ERRORMESSAGES_H
36
37 //----------------------------- HDF5 error messages --------------------------//
38
39 /// HDF5 error message
40 const char * const HDF5_ERR_FMT_FileNotCreated = "Error: File \"%s\" could not be created!\n";
41 /// HDF5 error message
42 const char * const HDF5_ERR_FMT_FileCannotRecreated = "Error: Cannot recreate an opened file \"%s\"!\n";
43 /// HDF5 error message
44 const char * const HDF5_ERR_FMT_FileCannotReopen = "Error: Cannot reopen an opened file \"%s\"!\n";
45 /// HDF5 error message
46 const char * const HDF5_ERR_FMT_FileNotClosed = "Error: File \"%s\" could not be closed!\n";
47 /// HDF5 error message
48 const char * const HDF5_ERR_FMT_CouldNotWriteTo = "Error: Could not write into \"%s\" dataset!\n";
49 /// HDF5 error message
50 const char * const HDF5_ERR_FMT_CouldNotReadFrom = "Error: Could not read from \"%s\" dataset!\n";
51 /// HDF5 error message
52 const char * const HDF5_ERR_FMT_WrongDimensionSizes = "Error: Dataset \"%s\" has wrong dimension sizes!\n";
53 /// HDF5 error message
54 const char * const HDF5_ERR_FMT_FileNotOpened = "Error: File \"%s\" could not be opened!\n";
55 /// HDF5 error message
56 const char * const HDF5_ERR_FMT_NotHDF5File = "Error: File \"%s\" is not a valid HDF5 file!\n";
57 /// HDF5 error message
58 const char * const HDF5_ERR_FMT_DatasetNotOpened = "Error: File \"%s\" could not open dataset \"%s\"!\n";
59 /// HDF5 error message
60 const char * const HDF5_ERR_FMT_CouldNotSetCompression = "Error: File \"%s\", dataset \"%s\" could set compression level [%ld]!\n";
61 /// HDF5 error message
62 const char * const HDF5_ERR_FMT_BadAttributeValue = "Error: Bad attribute value: [%s,%s] = %s";
63 /// HDF5 error message
64 const char * const HDF5_ERR_FMT_CouldNotWriteToAttribute = "Error: Could not write into \"%s\" attribute of \"%s\" dataset!\n";
65 /// HDF5 error message
66 const char * const HDF5_ERR_FMT_CouldNotReadFromAttribute = "Error: Could not read from \"%s\" attribute of \"%s\" dataset!\n";
67 /// HDF5 error message
68 const char * const HDF5_ERR_FMT_GroupNotCreated = "Error: Could not create group \"%s\" in file \"%s\"!\n";
69 /// HDF5 error message
70 const char * const HDF5_ERR_FMT_GroupNotOpened = "Error: Could not open group \"%s\" in file \"%s\"!\n";
71 /// HDF5 error message
72 const char * const HDF5_ERR_FMT_BadInputFileType = "Error: The input file has not a valid format!\n";
73 /// HDF5 error message
74 const char * const HDF5_ERR_FMT_BadOutputFileType = "Error: The output file has not a valid format!\n";
75 /// HDF5 error message
76 const char * const HDF5_ERR_FMT_BadCheckpointFileType = "Error: The checkpoint file has not a valid format!\n";
77
78 //---------------------------------- Matrix Classes -------------------------//
79
80 /// Matrix class error message
81 const char * const Matrix_ERR_FMT_NotEnoughMemory = "Error: Class %s: Memory allocation failed: Not Enough Memory\n";
82 /// Matrix class error message
83 const char * const Matrix_ERR_FMT_MatrixNotFloat = "Error: Matrix [%s] data type is not of single precision floating point!\n";
84 /// Matrix class error message
85 const char * const Matrix_ERR_FMT_MatrixNotReal = "Error: Matrix [%s] domain is not real!\n";
86 /// Matrix class error message
87 const char * const Matrix_ERR_FMT_MatrixNotComplex = "Error: Matrix [%s] domain is not complex!\n";
88 /// Matrix class error message
89 const char * const Matrix_ERR_FMT_MatrixNotLong = "Error: Matrix [%s] data type is not unsigned long (uint64_t)!\n";
90
91 //--------------------------------- Matrix Container ------------------------//
92
93 /// Matrix container error message
94 const char * const MatrixContainer_ERR_FMT_RecordUnknownDistributionType =
95 "K-Space panic: Matrix [%s] has unknown distribution type in the C++ code!\n\
96 [File, line] : [%s,%d]!\n";
97
98 /// Matrix container error message
99 const char * const MatrixContainer_ERR_FMT_ReloactaionError =
100 "K-Space panic: Matrix [%s] is being reallocated!\n\
101 [File, line] : [%s,%d]!\n";
102
103
104 //-------------------------- Command line Parameters ------------------------//
105
106 /// Command line parameters error message
107 const char * const CommandlineParameters_ERR_FMT_NoVerboseIntreval = "Command line parsing error: No or invalid verbose interval provided!\n";
108 /// Command line parameters error message
109 const char * const CommandlineParameters_ERR_FMT_NoThreadNumbers = "Command line parsing error: No or invalid number of CPU threads!\n";
110 /// Command line parameters error message
111 const char * const CommandlineParameters_ERR_FMT_NoCompressionLevel = "Command line parsing error: No or invalid compression level!\n";
112 /// Command line parameters error message
113 const char * const CommandlineParameters_ERR_FMT_NoStartTimestep = "Command line parsing error: No or invalid collection start time step!\n";
114 /// Command line parameters error message
115 const char * const CommandlineParameters_ERR_FMT_NoBenchmarkTimeStepCount = "Command line parsing error: No or invalid benchmark time step count!\n";
116 /// Command line parameters error message
117 const char * const CommandlineParameters_ERR_FMT_NoInputFile = "Error: The input file was not specified!\n";
118 /// Command line parameters error message
119 const char * const CommandlineParameters_ERR_FMT_NoOutputFile = "Error: The output file was not specified!\n";
120 /// Command line parameters error message
121 const char * const CommandlineParameters_ERR_FMT_NoCheckpointFile = "Error: The checkpoint file was not specified!\n";
122 /// Command line parameters error message
123 const char * const CommandlineParameters_ERR_FMT_NoCheckpointInterval = "Error: The checkpoint interval was not specified!\n";
124
125 /// Command line parameters error message
126 const char * const Parameters_ERR_FMT_Illegal_alpha_power_value = "Error: Illegal value of alpha_power!";
127 /// Command line parameters error message
128 const char * const Parameters_ERR_FMT_Illegal_StartTime_value = "Error: The start index is out of the simulation span <%ld, %ld>!\n";
129 /// Command line parameters error message
130 const char * const Parameters_ERR_FMT_IncorrectInputFileFormat = "Error: Incorrect input file\"%s\" format!\n";
131 /// Command line parameters error message
132 const char * const Parameters_ERR_FMT_IncorrectMajorHDF5FileVersion = "Error: Incorrect major version of the HDF5 file %s (expected is %s)!\n";
133 /// Command line parameters error message
134 const char * const Parameters_ERR_FMT_IncorrectMinorHDF5FileVersion = "Error: Incorrect minor version of the HDF5 file %s (expected is %s)!\n";
135 /// Command line parameters error message
136 const char * const Parameters_ERR_FMT_WrongSensorMaskType = "Error: The sensor mask type specified in the input file is not supported! \n";
137 /// Command line parameters error message
138 const char * const Parameters_ERR_FMT_UNonStaggeredNotSupportedForFile10 = "Error: --u_non_staggered_raw is not supported along with the input file of the version 1.0! \n";
139
140 //---------------------------------- FFTW Classes -------------------------//
141 /// FFTW error message
142 const char * const FFTWComplexMatrix_ERR_FMT_PlanNotCreated = "Error: The FFTW plan creation for %s failed! \n";
143 /// FFTW error message
144 const char * const FFTWComplexMatrix_ERR_FMT_InvalidPlan = "Error: Invalid plan for %s! \n";
145 /// FFTW error message
146 const char * const FFTW_WARNING_FMT_WisdomNotExported = "Warning: Wisdom could not be exported!\n";
147 /// FFTW error message
148 const char * const FFTW_WARNING_FMT_WisdomNotImported = "Warning: Wisdom could not be imported!\n";
149
150
151 //------------------------- KSpaceFirstOrder3DSolver Classes ----------------//
152
153 /// KSpaceFirstOrder3DSolver error message
154 const char * const KSpaceFirstOrder3DSolver_ERR_FMT_IncorrectCheckpointFileFormat
155 = "Error: Incorrect checkpoint file \"%s\" format!\n";
156
157 /// KSpaceFirstOrder3DSolver error message
158 const char * const KSpaceFirstOrder3DSolver_ERR_FMT_IncorrectOutputFileFormat
159 = "Error: Incorrect output file \"%s\" format!\n";
160
161 /// KSpaceFirstOrder3DSolver error message
162 const char * const KSpaceFirstOrder3DSolver_ERR_FMT_CheckpointDimensionsDoNotMatch
163 = "Error: The dimensions [%ld, %ld, %ld] of the checkpoint file don't match the simulation dimensions [%ld, %ld, %ld] \n";
164
165 /// KSpaceFirstOrder3DSolver error message
166 const char * const KSpaceFirstOrder3DSolver_ERR_FMT_OutputDimensionsDoNotMatch
167 = "Error: The dimensions [%ld, %ld, %ld] of the output file don't match the simulation dimensions [%ld, %ld, %ld] \n";
168
169
170 #endif /* ERRORMESSAGES_H */
171
FFTWComplexMatrix_ERR_FMT_InvalidPlan
const char *const FFTWComplexMatrix_ERR_FMT_InvalidPlan
FFTW error message.
Definition: ErrorMessages.h:144
KSpaceFirstOrder3DSolver_ERR_FMT_CheckpointDimensionsDoNotMatch
const char *const KSpaceFirstOrder3DSolver_ERR_FMT_CheckpointDimensionsDoNotMatch
KSpaceFirstOrder3DSolver error message.
Definition: ErrorMessages.h:163
CommandlineParameters_ERR_FMT_NoCheckpointFile
const char *const CommandlineParameters_ERR_FMT_NoCheckpointFile
Command line parameters error message.
Definition: ErrorMessages.h:121
Parameters_ERR_FMT_IncorrectMajorHDF5FileVersion
const char *const Parameters_ERR_FMT_IncorrectMajorHDF5FileVersion
Command line parameters error message.
Definition: ErrorMessages.h:132
CommandlineParameters_ERR_FMT_NoInputFile
const char *const CommandlineParameters_ERR_FMT_NoInputFile
Command line parameters error message.
Definition: ErrorMessages.h:117
HDF5_ERR_FMT_GroupNotOpened
const char *const HDF5_ERR_FMT_GroupNotOpened
HDF5 error message.
Definition: ErrorMessages.h:70
Parameters_ERR_FMT_WrongSensorMaskType
const char *const Parameters_ERR_FMT_WrongSensorMaskType
Command line parameters error message.
Definition: ErrorMessages.h:136
Parameters_ERR_FMT_UNonStaggeredNotSupportedForFile10
const char *const Parameters_ERR_FMT_UNonStaggeredNotSupportedForFile10
Command line parameters error message.
Definition: ErrorMessages.h:138
HDF5_ERR_FMT_DatasetNotOpened
const char *const HDF5_ERR_FMT_DatasetNotOpened
HDF5 error message.
Definition: ErrorMessages.h:58
HDF5_ERR_FMT_CouldNotReadFrom
const char *const HDF5_ERR_FMT_CouldNotReadFrom
HDF5 error message.
Definition: ErrorMessages.h:50
KSpaceFirstOrder3DSolver_ERR_FMT_IncorrectCheckpointFileFormat
const char *const KSpaceFirstOrder3DSolver_ERR_FMT_IncorrectCheckpointFileFormat
KSpaceFirstOrder3DSolver error message.
Definition: ErrorMessages.h:155
HDF5_ERR_FMT_FileNotClosed
const char *const HDF5_ERR_FMT_FileNotClosed
HDF5 error message.
Definition: ErrorMessages.h:46
Parameters_ERR_FMT_IncorrectInputFileFormat
const char *const Parameters_ERR_FMT_IncorrectInputFileFormat
Command line parameters error message.
Definition: ErrorMessages.h:130
HDF5_ERR_FMT_NotHDF5File
const char *const HDF5_ERR_FMT_NotHDF5File
HDF5 error message.
Definition: ErrorMessages.h:56
HDF5_ERR_FMT_BadCheckpointFileType
const char *const HDF5_ERR_FMT_BadCheckpointFileType
HDF5 error message.
Definition: ErrorMessages.h:76
HDF5_ERR_FMT_BadOutputFileType
const char *const HDF5_ERR_FMT_BadOutputFileType
HDF5 error message.
Definition: ErrorMessages.h:74
KSpaceFirstOrder3DSolver_ERR_FMT_IncorrectOutputFileFormat
const char *const KSpaceFirstOrder3DSolver_ERR_FMT_IncorrectOutputFileFormat
KSpaceFirstOrder3DSolver error message.
Definition: ErrorMessages.h:159
CommandlineParameters_ERR_FMT_NoThreadNumbers
const char *const CommandlineParameters_ERR_FMT_NoThreadNumbers
Command line parameters error message.
Definition: ErrorMessages.h:109
FFTW_WARNING_FMT_WisdomNotImported
const char *const FFTW_WARNING_FMT_WisdomNotImported
FFTW error message.
Definition: ErrorMessages.h:148
KSpaceFirstOrder3DSolver_ERR_FMT_OutputDimensionsDoNotMatch
const char *const KSpaceFirstOrder3DSolver_ERR_FMT_OutputDimensionsDoNotMatch
KSpaceFirstOrder3DSolver error message.
Definition: ErrorMessages.h:167
CommandlineParameters_ERR_FMT_NoVerboseIntreval
const char *const CommandlineParameters_ERR_FMT_NoVerboseIntreval
Command line parameters error message.
Definition: ErrorMessages.h:107
HDF5_ERR_FMT_WrongDimensionSizes
const char *const HDF5_ERR_FMT_WrongDimensionSizes
HDF5 error message.
Definition: ErrorMessages.h:52
HDF5_ERR_FMT_CouldNotSetCompression
const char *const HDF5_ERR_FMT_CouldNotSetCompression
HDF5 error message.
Definition: ErrorMessages.h:60
HDF5_ERR_FMT_FileCannotReopen
const char *const HDF5_ERR_FMT_FileCannotReopen
HDF5 error message.
Definition: ErrorMessages.h:44
FFTWComplexMatrix_ERR_FMT_PlanNotCreated
const char *const FFTWComplexMatrix_ERR_FMT_PlanNotCreated
FFTW error message.
Definition: ErrorMessages.h:142
HDF5_ERR_FMT_BadInputFileType
const char *const HDF5_ERR_FMT_BadInputFileType
HDF5 error message.
Definition: ErrorMessages.h:72
Parameters_ERR_FMT_Illegal_alpha_power_value
const char *const Parameters_ERR_FMT_Illegal_alpha_power_value
Command line parameters error message.
Definition: ErrorMessages.h:126
HDF5_ERR_FMT_CouldNotWriteToAttribute
const char *const HDF5_ERR_FMT_CouldNotWriteToAttribute
HDF5 error message.
Definition: ErrorMessages.h:64
FFTW_WARNING_FMT_WisdomNotExported
const char *const FFTW_WARNING_FMT_WisdomNotExported
FFTW error message.
Definition: ErrorMessages.h:146
MatrixContainer_ERR_FMT_ReloactaionError
const char *const MatrixContainer_ERR_FMT_ReloactaionError
Matrix container error message.
Definition: ErrorMessages.h:99
HDF5_ERR_FMT_FileNotOpened
const char *const HDF5_ERR_FMT_FileNotOpened
HDF5 error message.
Definition: ErrorMessages.h:54
MatrixContainer_ERR_FMT_RecordUnknownDistributionType
const char *const MatrixContainer_ERR_FMT_RecordUnknownDistributionType
Matrix container error message.
Definition: ErrorMessages.h:94
HDF5_ERR_FMT_CouldNotWriteTo
const char *const HDF5_ERR_FMT_CouldNotWriteTo
HDF5 error message.
Definition: ErrorMessages.h:48
CommandlineParameters_ERR_FMT_NoStartTimestep
const char *const CommandlineParameters_ERR_FMT_NoStartTimestep
Command line parameters error message.
Definition: ErrorMessages.h:113
Parameters_ERR_FMT_IncorrectMinorHDF5FileVersion
const char *const Parameters_ERR_FMT_IncorrectMinorHDF5FileVersion
Command line parameters error message.
Definition: ErrorMessages.h:134
CommandlineParameters_ERR_FMT_NoCheckpointInterval
const char *const CommandlineParameters_ERR_FMT_NoCheckpointInterval
Command line parameters error message.
Definition: ErrorMessages.h:123
CommandlineParameters_ERR_FMT_NoOutputFile
const char *const CommandlineParameters_ERR_FMT_NoOutputFile
Command line parameters error message.
Definition: ErrorMessages.h:119
HDF5_ERR_FMT_GroupNotCreated
const char *const HDF5_ERR_FMT_GroupNotCreated
HDF5 error message.
Definition: ErrorMessages.h:68
HDF5_ERR_FMT_FileCannotRecreated
const char *const HDF5_ERR_FMT_FileCannotRecreated
HDF5 error message.
Definition: ErrorMessages.h:42
HDF5_ERR_FMT_BadAttributeValue
const char *const HDF5_ERR_FMT_BadAttributeValue
HDF5 error message.
Definition: ErrorMessages.h:62
Matrix_ERR_FMT_MatrixNotLong
const char *const Matrix_ERR_FMT_MatrixNotLong
Matrix class error message.
Definition: ErrorMessages.h:89
HDF5_ERR_FMT_CouldNotReadFromAttribute
const char *const HDF5_ERR_FMT_CouldNotReadFromAttribute
HDF5 error message.
Definition: ErrorMessages.h:66
Matrix_ERR_FMT_MatrixNotComplex
const char *const Matrix_ERR_FMT_MatrixNotComplex
Matrix class error message.
Definition: ErrorMessages.h:87
CommandlineParameters_ERR_FMT_NoBenchmarkTimeStepCount
const char *const CommandlineParameters_ERR_FMT_NoBenchmarkTimeStepCount
Command line parameters error message.
Definition: ErrorMessages.h:115
CommandlineParameters_ERR_FMT_NoCompressionLevel
const char *const CommandlineParameters_ERR_FMT_NoCompressionLevel
Command line parameters error message.
Definition: ErrorMessages.h:111
Matrix_ERR_FMT_MatrixNotFloat
const char *const Matrix_ERR_FMT_MatrixNotFloat
Matrix class error message.
Definition: ErrorMessages.h:83
Matrix_ERR_FMT_NotEnoughMemory
const char *const Matrix_ERR_FMT_NotEnoughMemory
Matrix class error message.
Definition: ErrorMessages.h:81
Matrix_ERR_FMT_MatrixNotReal
const char *const Matrix_ERR_FMT_MatrixNotReal
Matrix class error message.
Definition: ErrorMessages.h:85
Parameters_ERR_FMT_Illegal_StartTime_value
const char *const Parameters_ERR_FMT_Illegal_StartTime_value
Command line parameters error message.
Definition: ErrorMessages.h:128
HDF5_ERR_FMT_FileNotCreated
const char *const HDF5_ERR_FMT_FileNotCreated
HDF5 error message.
Definition: ErrorMessages.h:40