[219] | 1 | #include "file.hpp" |
---|
| 2 | |
---|
[352] | 3 | #include "attribute_template.hpp" |
---|
| 4 | #include "object_template.hpp" |
---|
| 5 | #include "group_template.hpp" |
---|
[219] | 6 | #include "object_factory.hpp" |
---|
[300] | 7 | #include "context.hpp" |
---|
| 8 | #include "context_server.hpp" |
---|
| 9 | #include "nc4_data_output.hpp" |
---|
[599] | 10 | #include "nc4_data_input.hpp" |
---|
[318] | 11 | #include "calendar_util.hpp" |
---|
| 12 | #include "date.hpp" |
---|
[352] | 13 | #include "message.hpp" |
---|
| 14 | #include "type.hpp" |
---|
[591] | 15 | #include "xios_spl.hpp" |
---|
[1158] | 16 | #include "context_client.hpp" |
---|
[382] | 17 | #include "mpi.hpp" |
---|
[1158] | 18 | #include "timer.hpp" |
---|
[1234] | 19 | #include "server.hpp" |
---|
[219] | 20 | |
---|
[335] | 21 | namespace xios { |
---|
[509] | 22 | |
---|
[878] | 23 | /// ////////////////////// Dfinitions ////////////////////// /// |
---|
[219] | 24 | |
---|
| 25 | CFile::CFile(void) |
---|
| 26 | : CObjectTemplate<CFile>(), CFileAttributes() |
---|
[379] | 27 | , vFieldGroup(), data_out(), enabledFields(), fileComm(MPI_COMM_NULL) |
---|
[1232] | 28 | , isOpen(false), read_client(0), checkRead(false), allZoneEmpty(false) |
---|
[509] | 29 | { |
---|
[957] | 30 | setVirtualFieldGroup(CFieldGroup::create(getId() + "_virtual_field_group")); |
---|
| 31 | setVirtualVariableGroup(CVariableGroup::create(getId() + "_virtual_variable_group")); |
---|
[472] | 32 | } |
---|
[219] | 33 | |
---|
| 34 | CFile::CFile(const StdString & id) |
---|
| 35 | : CObjectTemplate<CFile>(id), CFileAttributes() |
---|
[379] | 36 | , vFieldGroup(), data_out(), enabledFields(), fileComm(MPI_COMM_NULL) |
---|
[1232] | 37 | , isOpen(false), read_client(0), checkRead(false), allZoneEmpty(false) |
---|
[509] | 38 | { |
---|
[957] | 39 | setVirtualFieldGroup(CFieldGroup::create(getId() + "_virtual_field_group")); |
---|
| 40 | setVirtualVariableGroup(CVariableGroup::create(getId() + "_virtual_variable_group")); |
---|
[472] | 41 | } |
---|
[219] | 42 | |
---|
| 43 | CFile::~CFile(void) |
---|
| 44 | { /* Ne rien faire de plus */ } |
---|
| 45 | |
---|
| 46 | ///--------------------------------------------------------------- |
---|
[509] | 47 | //! Get name of file |
---|
[219] | 48 | StdString CFile::GetName(void) { return (StdString("file")); } |
---|
| 49 | StdString CFile::GetDefName(void){ return (CFile::GetName()); } |
---|
| 50 | ENodeType CFile::GetType(void) { return (eFile); } |
---|
| 51 | |
---|
| 52 | //---------------------------------------------------------------- |
---|
[773] | 53 | |
---|
[1158] | 54 | const StdString CFile::getFileOutputName(void) const |
---|
[773] | 55 | { |
---|
[1158] | 56 | return (name.isEmpty() ? getId() : name) + (name_suffix.isEmpty() ? StdString("") : name_suffix.getValue()); |
---|
[773] | 57 | } |
---|
| 58 | |
---|
| 59 | //---------------------------------------------------------------- |
---|
[509] | 60 | /*! |
---|
[599] | 61 | \brief Get data writer object. |
---|
[509] | 62 | Each enabled file in xml represents a physical netcdf file. |
---|
[599] | 63 | This function allows to access the data writer object. |
---|
| 64 | \return data writer object. |
---|
[509] | 65 | */ |
---|
[337] | 66 | boost::shared_ptr<CDataOutput> CFile::getDataOutput(void) const |
---|
[219] | 67 | { |
---|
[599] | 68 | return data_out; |
---|
[219] | 69 | } |
---|
| 70 | |
---|
[509] | 71 | /*! |
---|
[599] | 72 | \brief Get data reader object. |
---|
| 73 | Each enabled file in xml represents a physical netcdf file. |
---|
| 74 | This function allows to access the data reader object. |
---|
| 75 | \return data reader object. |
---|
| 76 | */ |
---|
| 77 | boost::shared_ptr<CDataInput> CFile::getDataInput(void) const |
---|
| 78 | { |
---|
| 79 | return data_in; |
---|
| 80 | } |
---|
| 81 | |
---|
| 82 | /*! |
---|
[509] | 83 | \brief Get virtual field group |
---|
| 84 | In each file, there always exists a field group which is the ancestor of all |
---|
| 85 | fields in the file. This is considered be virtual because it is created automatically during |
---|
| 86 | file initialization and it normally doesn't appear on xml file |
---|
| 87 | \return Pointer to field group |
---|
| 88 | */ |
---|
[347] | 89 | CFieldGroup* CFile::getVirtualFieldGroup(void) const |
---|
[219] | 90 | { |
---|
| 91 | return (this->vFieldGroup); |
---|
| 92 | } |
---|
| 93 | |
---|
[509] | 94 | /*! |
---|
| 95 | \brief Get virtual variable group |
---|
| 96 | In each file, there always exists a variable group which is the ancestor of all |
---|
| 97 | variable in the file. This is considered be virtual because it is created automatically during |
---|
| 98 | file initialization and it normally doesn't appear on xml file |
---|
| 99 | \return Pointer to variable group |
---|
| 100 | */ |
---|
[472] | 101 | CVariableGroup* CFile::getVirtualVariableGroup(void) const |
---|
| 102 | { |
---|
| 103 | return (this->vVariableGroup); |
---|
| 104 | } |
---|
| 105 | |
---|
[509] | 106 | //! Get all fields of a file |
---|
[347] | 107 | std::vector<CField*> CFile::getAllFields(void) const |
---|
[219] | 108 | { |
---|
| 109 | return (this->vFieldGroup->getAllChildren()); |
---|
| 110 | } |
---|
[509] | 111 | |
---|
| 112 | //! Get all variables of a file |
---|
[472] | 113 | std::vector<CVariable*> CFile::getAllVariables(void) const |
---|
| 114 | { |
---|
| 115 | return (this->vVariableGroup->getAllChildren()); |
---|
| 116 | } |
---|
[219] | 117 | |
---|
| 118 | //---------------------------------------------------------------- |
---|
[509] | 119 | /*! |
---|
| 120 | \brief Get all enabled fields of file |
---|
| 121 | A field is considered to be enabled if it fullfil these conditions: it is enabled, inside a enabled file |
---|
| 122 | and its own level is not larger than file output level. |
---|
| 123 | \param [in] default_outputlevel default value output level of file |
---|
| 124 | \param [in] default_level default value level of field |
---|
| 125 | \param [in] default_enabled flag determine by default if field is enabled |
---|
| 126 | \return Vector of pointers of enabled fields |
---|
| 127 | */ |
---|
| 128 | std::vector<CField*> CFile::getEnabledFields(int default_outputlevel, |
---|
[347] | 129 | int default_level, |
---|
| 130 | bool default_enabled) |
---|
[219] | 131 | { |
---|
| 132 | if (!this->enabledFields.empty()) |
---|
| 133 | return (this->enabledFields); |
---|
| 134 | |
---|
| 135 | const int _outputlevel = |
---|
| 136 | (!output_level.isEmpty()) ? output_level.getValue() : default_outputlevel; |
---|
[347] | 137 | std::vector<CField*>::iterator it; |
---|
[219] | 138 | this->enabledFields = this->getAllFields(); |
---|
| 139 | |
---|
[347] | 140 | std::vector<CField*> newEnabledFields; |
---|
[509] | 141 | |
---|
[651] | 142 | for ( it = this->enabledFields.begin(); it != this->enabledFields.end(); it++ ) |
---|
[219] | 143 | { |
---|
[878] | 144 | if (!(*it)->enabled.isEmpty()) // Si l'attribut 'enabled' est dfini ... |
---|
[219] | 145 | { |
---|
[300] | 146 | if (! (*it)->enabled.getValue()) continue; |
---|
| 147 | // { it--; this->enabledFields.erase(it+1); continue; } |
---|
[219] | 148 | } |
---|
[878] | 149 | else // Si l'attribut 'enabled' n'est pas dfini ... |
---|
[219] | 150 | { |
---|
[651] | 151 | if (!default_enabled) continue; |
---|
[300] | 152 | // { it--; this->enabledFields.erase(it+1); continue; } |
---|
[219] | 153 | } |
---|
| 154 | |
---|
[878] | 155 | if (!(*it)->level.isEmpty()) // Si l'attribut 'level' est dfini ... |
---|
[219] | 156 | { |
---|
[651] | 157 | if ((*it)->level.getValue() > _outputlevel) continue; |
---|
[300] | 158 | // { it--; this->enabledFields.erase(it+1); continue; } |
---|
[219] | 159 | } |
---|
[878] | 160 | else // Si l'attribut 'level' n'est pas dfini ... |
---|
[219] | 161 | { |
---|
[651] | 162 | if (default_level > _outputlevel) continue; |
---|
[300] | 163 | // { it--; this->enabledFields.erase(it+1); continue; } |
---|
[219] | 164 | } |
---|
[509] | 165 | |
---|
[651] | 166 | // CField* field_tmp=(*it).get(); |
---|
| 167 | // shared_ptr<CField> sptfield=*it; |
---|
| 168 | // field_tmp->refObject.push_back(sptfield); |
---|
| 169 | newEnabledFields.push_back(*it); |
---|
[286] | 170 | // Le champ est finalement actif, on y ajoute sa propre reference. |
---|
[459] | 171 | // (*it)->refObject.push_back(*it); |
---|
[878] | 172 | // Le champ est finalement actif, on y ajoute la rfrence au champ de base. |
---|
[346] | 173 | (*it)->setRelFile(CFile::get(this)); |
---|
[219] | 174 | } |
---|
[651] | 175 | enabledFields = newEnabledFields; |
---|
[219] | 176 | |
---|
| 177 | return (this->enabledFields); |
---|
| 178 | } |
---|
| 179 | |
---|
| 180 | //---------------------------------------------------------------- |
---|
[509] | 181 | //! Change virtual field group to a new one |
---|
[347] | 182 | void CFile::setVirtualFieldGroup(CFieldGroup* newVFieldGroup) |
---|
[509] | 183 | { |
---|
| 184 | this->vFieldGroup = newVFieldGroup; |
---|
[219] | 185 | } |
---|
| 186 | |
---|
[509] | 187 | //! Change virtual variable group to new one |
---|
[472] | 188 | void CFile::setVirtualVariableGroup(CVariableGroup* newVVariableGroup) |
---|
[509] | 189 | { |
---|
| 190 | this->vVariableGroup = newVVariableGroup; |
---|
[472] | 191 | } |
---|
| 192 | |
---|
[219] | 193 | //---------------------------------------------------------------- |
---|
[318] | 194 | bool CFile::isSyncTime(void) |
---|
| 195 | { |
---|
[651] | 196 | CContext* context = CContext::getCurrent(); |
---|
| 197 | const CDate& currentDate = context->calendar->getCurrentDate(); |
---|
[538] | 198 | if (!sync_freq.isEmpty()) |
---|
[318] | 199 | { |
---|
[651] | 200 | if (lastSync + sync_freq.getValue() < currentDate) |
---|
[318] | 201 | { |
---|
[651] | 202 | lastSync = currentDate; |
---|
| 203 | return true; |
---|
[318] | 204 | } |
---|
| 205 | } |
---|
[651] | 206 | return false; |
---|
[318] | 207 | } |
---|
[509] | 208 | |
---|
| 209 | //! Initialize a file in order to write into it |
---|
[1232] | 210 | void CFile::initWrite(void) |
---|
[321] | 211 | { |
---|
[651] | 212 | CContext* context = CContext::getCurrent(); |
---|
| 213 | const CDate& currentDate = context->calendar->getCurrentDate(); |
---|
| 214 | CContextServer* server = context->server; |
---|
[509] | 215 | |
---|
[651] | 216 | lastSync = currentDate; |
---|
| 217 | lastSplit = currentDate; |
---|
[702] | 218 | if (!split_freq.isEmpty()) |
---|
| 219 | { |
---|
[1158] | 220 | StdString keySuffix("CContext_"+CContext::getCurrent()->getId()+"::CFile_"+getFileOutputName()+"::") ; |
---|
| 221 | if (context->registryIn->foundKey(keySuffix+"splitStart") && context->registryIn->foundKey(keySuffix+"splitEnd")) |
---|
[702] | 222 | { |
---|
| 223 | CDate savedSplitStart(*context->getCalendar()), savedSplitEnd(*context->getCalendar()); |
---|
[1158] | 224 | context->registryIn->getKey(keySuffix+"splitStart", savedSplitStart); |
---|
| 225 | context->registryIn->getKey(keySuffix+"splitEnd", savedSplitEnd); |
---|
[702] | 226 | |
---|
| 227 | if (savedSplitStart <= lastSplit && lastSplit <= savedSplitEnd) |
---|
| 228 | lastSplit = savedSplitStart; |
---|
| 229 | } |
---|
| 230 | } |
---|
[1232] | 231 | isOpen = false; |
---|
[379] | 232 | |
---|
[952] | 233 | // if (!record_offset.isEmpty() && record_offset < 0) |
---|
| 234 | // ERROR("void CFile::initFile(void)", |
---|
| 235 | // "Invalid 'record_offset', this attribute cannot be negative."); |
---|
| 236 | const int recordOffset = record_offset.isEmpty() ? 0 : record_offset; |
---|
[757] | 237 | |
---|
[1009] | 238 | set<StdString> setAxis; |
---|
| 239 | set<StdString> setDomains; |
---|
[379] | 240 | |
---|
| 241 | std::vector<CField*>::iterator it, end = this->enabledFields.end(); |
---|
[609] | 242 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
[379] | 243 | { |
---|
[1232] | 244 | CField* field = *it; |
---|
[609] | 245 | std::vector<CAxis*> vecAxis = field->grid->getAxis(); |
---|
| 246 | for (size_t i = 0; i < vecAxis.size(); ++i) |
---|
[1009] | 247 | setAxis.insert(vecAxis[i]->getAxisOutputName()); |
---|
[609] | 248 | std::vector<CDomain*> vecDomains = field->grid->getDomains(); |
---|
| 249 | for (size_t i = 0; i < vecDomains.size(); ++i) |
---|
[1009] | 250 | setDomains.insert(vecDomains[i]->getDomainOutputName()); |
---|
[757] | 251 | |
---|
| 252 | field->resetNStep(recordOffset); |
---|
[379] | 253 | } |
---|
[609] | 254 | nbAxis = setAxis.size(); |
---|
| 255 | nbDomains = setDomains.size(); |
---|
[379] | 256 | |
---|
[509] | 257 | // create sub communicator for file |
---|
[1232] | 258 | createSubComFile(); |
---|
[692] | 259 | |
---|
[1158] | 260 | // if (time_counter.isEmpty()) time_counter.setValue(time_counter_attr::centered); |
---|
[802] | 261 | if (time_counter_name.isEmpty()) time_counter_name = "time_counter"; |
---|
[321] | 262 | } |
---|
[509] | 263 | |
---|
[1232] | 264 | //! Initialize a file in order to write into it |
---|
| 265 | void CFile::initRead(void) |
---|
| 266 | { |
---|
| 267 | if (checkRead) return; |
---|
| 268 | createSubComFile(); |
---|
| 269 | checkRead = true; |
---|
| 270 | } |
---|
| 271 | |
---|
| 272 | /*! |
---|
| 273 | Create a sub communicator in which processes participate in reading/opening file |
---|
| 274 | */ |
---|
| 275 | void CFile::createSubComFile() |
---|
| 276 | { |
---|
| 277 | CContext* context = CContext::getCurrent(); |
---|
| 278 | CContextServer* server = context->server; |
---|
| 279 | |
---|
| 280 | // create sub communicator for file |
---|
| 281 | allZoneEmpty = true; |
---|
| 282 | std::vector<CField*>::iterator it, end = this->enabledFields.end(); |
---|
| 283 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
| 284 | { |
---|
| 285 | CField* field = *it; |
---|
| 286 | bool nullGrid = (0 == field->grid); |
---|
| 287 | allZoneEmpty &= nullGrid ? false : !field->grid->doGridHaveDataToWrite(); |
---|
| 288 | } |
---|
| 289 | |
---|
| 290 | int color = allZoneEmpty ? 0 : 1; |
---|
| 291 | MPI_Comm_split(server->intraComm, color, server->intraCommRank, &fileComm); |
---|
| 292 | if (allZoneEmpty) MPI_Comm_free(&fileComm); |
---|
| 293 | } |
---|
| 294 | |
---|
[1136] | 295 | /* |
---|
| 296 | Check condition to write into a file |
---|
| 297 | For now, we only use the level-2 server to write files (if this mode is activated) |
---|
| 298 | or classical server to do this job. |
---|
| 299 | */ |
---|
| 300 | void CFile::checkWriteFile(void) |
---|
[321] | 301 | { |
---|
[1054] | 302 | CContext* context = CContext::getCurrent(); |
---|
| 303 | // Done by classical server or secondary server |
---|
[1136] | 304 | // This condition should be changed soon |
---|
[1234] | 305 | if (CServer::serverLevel == 0 || CServer::serverLevel == 2) |
---|
[599] | 306 | { |
---|
[1054] | 307 | if (mode.isEmpty() || mode.getValue() == mode_attr::write) |
---|
| 308 | { |
---|
[1158] | 309 | CTimer::get("Files : create headers").resume(); |
---|
[1054] | 310 | if (!isOpen) createHeader(); |
---|
[1158] | 311 | CTimer::get("Files : create headers").suspend(); |
---|
[1054] | 312 | checkSync(); |
---|
[1136] | 313 | } |
---|
| 314 | checkSplit(); // REally need this? |
---|
| 315 | } |
---|
| 316 | } |
---|
| 317 | |
---|
| 318 | /* |
---|
| 319 | Check condition to read from a file |
---|
| 320 | For now, we only use the level-1 server to write files (if this mode is activated) |
---|
| 321 | or classical server to do this job. |
---|
| 322 | This function can be used by client for reading metadata |
---|
| 323 | */ |
---|
| 324 | void CFile::checkReadFile(void) |
---|
| 325 | { |
---|
| 326 | CContext* context = CContext::getCurrent(); |
---|
| 327 | // Done by classical server or secondary server |
---|
| 328 | // TODO: This condition should be changed soon. It only works with maximum number of level as 2 |
---|
[1239] | 329 | if (CServer::serverLevel == 0 || CServer::serverLevel == 1) |
---|
[1136] | 330 | { |
---|
| 331 | if (!mode.isEmpty() && mode.getValue() == mode_attr::read) |
---|
[1054] | 332 | { |
---|
[1158] | 333 | CTimer::get("Files : open headers").resume(); |
---|
[1232] | 334 | |
---|
| 335 | if (!isOpen) openInReadMode(); |
---|
| 336 | |
---|
[1158] | 337 | CTimer::get("Files : open headers").suspend(); |
---|
[1054] | 338 | } |
---|
[1136] | 339 | //checkSplit(); // Really need for reading? |
---|
[599] | 340 | } |
---|
[321] | 341 | } |
---|
[509] | 342 | |
---|
| 343 | /*! |
---|
[1232] | 344 | Verify if a process participates in an opening-file communicator |
---|
| 345 | \return true if the process doesn't participate in opening file |
---|
| 346 | */ |
---|
| 347 | bool CFile::isEmptyZone() |
---|
| 348 | { |
---|
| 349 | return allZoneEmpty; |
---|
| 350 | } |
---|
| 351 | |
---|
| 352 | /*! |
---|
[509] | 353 | \brief Verify if synchronisation should be done |
---|
| 354 | If syn option is enabled, syn frequence and current time will be used to |
---|
| 355 | calculate the moment to syn file(s) |
---|
| 356 | \return True if it is the moment to synchronize file, otherwise false |
---|
| 357 | */ |
---|
[321] | 358 | bool CFile::checkSync(void) |
---|
| 359 | { |
---|
[651] | 360 | CContext* context = CContext::getCurrent(); |
---|
| 361 | const CDate& currentDate = context->calendar->getCurrentDate(); |
---|
[538] | 362 | if (!sync_freq.isEmpty()) |
---|
[321] | 363 | { |
---|
[651] | 364 | if (lastSync + sync_freq.getValue() <= currentDate) |
---|
[321] | 365 | { |
---|
[651] | 366 | lastSync = currentDate; |
---|
| 367 | data_out->syncFile(); |
---|
| 368 | return true; |
---|
[321] | 369 | } |
---|
| 370 | } |
---|
[651] | 371 | return false; |
---|
[321] | 372 | } |
---|
[509] | 373 | |
---|
| 374 | /*! |
---|
| 375 | \brief Verify if splitting should be done |
---|
| 376 | If split option is enabled, split frequence and current time will be used to |
---|
| 377 | calculate the moment to split file |
---|
| 378 | \return True if it is the moment to split file, otherwise false |
---|
| 379 | */ |
---|
[321] | 380 | bool CFile::checkSplit(void) |
---|
| 381 | { |
---|
[651] | 382 | CContext* context = CContext::getCurrent(); |
---|
| 383 | const CDate& currentDate = context->calendar->getCurrentDate(); |
---|
[538] | 384 | if (!split_freq.isEmpty()) |
---|
[321] | 385 | { |
---|
[651] | 386 | if (currentDate > lastSplit + split_freq.getValue()) |
---|
[321] | 387 | { |
---|
[651] | 388 | lastSplit = lastSplit + split_freq.getValue(); |
---|
[347] | 389 | std::vector<CField*>::iterator it, end = this->enabledFields.end(); |
---|
[599] | 390 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
| 391 | { |
---|
| 392 | (*it)->resetNStep(); |
---|
| 393 | (*it)->resetNStepMax(); |
---|
| 394 | } |
---|
| 395 | if (mode.isEmpty() || mode.getValue() == mode_attr::write) |
---|
[651] | 396 | createHeader(); |
---|
[599] | 397 | else |
---|
| 398 | openInReadMode(); |
---|
[651] | 399 | return true; |
---|
[321] | 400 | } |
---|
| 401 | } |
---|
[651] | 402 | return false; |
---|
[321] | 403 | } |
---|
[509] | 404 | |
---|
| 405 | /*! |
---|
| 406 | \brief Create header of netcdf file |
---|
| 407 | There are some information to fill in header of each netcdf. |
---|
| 408 | */ |
---|
[300] | 409 | void CFile::createHeader(void) |
---|
[219] | 410 | { |
---|
[651] | 411 | CContext* context = CContext::getCurrent(); |
---|
| 412 | CContextServer* server = context->server; |
---|
[509] | 413 | |
---|
[1232] | 414 | if (!allZoneEmpty) |
---|
[219] | 415 | { |
---|
[773] | 416 | StdString filename = getFileOutputName(); |
---|
[875] | 417 | |
---|
| 418 | // determine splitting format in the file name : firstPart%start_date%middlePart%end_date%lastPart |
---|
| 419 | |
---|
| 420 | std::string strStartDate="%start_date%" ; |
---|
| 421 | std::string strEndDate="%end_date%" ; |
---|
| 422 | |
---|
| 423 | std::string firstPart ; |
---|
| 424 | std::string middlePart ; |
---|
| 425 | std::string lastPart ; |
---|
| 426 | size_t pos1, pos2 ; |
---|
| 427 | bool hasStartDate=false ; |
---|
[920] | 428 | bool hasEndDate=false ; |
---|
| 429 | bool hasSplit = (!split_freq.isEmpty()); |
---|
[875] | 430 | |
---|
| 431 | pos1=filename.find(strStartDate) ; |
---|
| 432 | if (pos1!=std::string::npos) |
---|
| 433 | { |
---|
| 434 | firstPart=filename.substr(0,pos1) ; |
---|
| 435 | pos1+=strStartDate.size() ; |
---|
| 436 | hasStartDate=true ; |
---|
| 437 | } |
---|
| 438 | else pos1=0 ; |
---|
| 439 | |
---|
| 440 | pos2=filename.find(strEndDate,pos1) ; |
---|
| 441 | if (pos2!=std::string::npos) |
---|
| 442 | { |
---|
| 443 | middlePart=filename.substr(pos1,pos2-pos1) ; |
---|
| 444 | pos2+=strEndDate.size() ; |
---|
| 445 | lastPart=filename.substr(pos2,filename.size()-pos2) ; |
---|
| 446 | hasEndDate=true ; |
---|
| 447 | } |
---|
| 448 | else middlePart=filename.substr(pos1,filename.size()) ; |
---|
| 449 | |
---|
| 450 | if (!hasStartDate && !hasEndDate) |
---|
| 451 | { |
---|
| 452 | hasStartDate=true ; |
---|
| 453 | hasEndDate=true; |
---|
| 454 | firstPart=middlePart ; |
---|
[920] | 455 | if (hasSplit) firstPart +="_"; |
---|
[875] | 456 | middlePart="-" ; |
---|
| 457 | } |
---|
[920] | 458 | |
---|
[300] | 459 | StdOStringStream oss; |
---|
[538] | 460 | |
---|
[431] | 461 | if (!split_freq.isEmpty()) |
---|
| 462 | { |
---|
[1201] | 463 | CDate split_start ; |
---|
| 464 | CDate splitEnd ; |
---|
| 465 | if (!split_start_offset.isEmpty()) split_start=lastSplit + split_start_offset ; |
---|
| 466 | else split_start=lastSplit ; |
---|
[702] | 467 | |
---|
[1201] | 468 | splitEnd = lastSplit + split_freq ; |
---|
| 469 | if (!split_last_date.isEmpty()) |
---|
| 470 | { |
---|
| 471 | CDate splitLastDate=CDate::FromString(split_last_date,*CContext::getCurrent()->getCalendar()) ; |
---|
| 472 | if( splitLastDate < splitEnd) splitEnd=splitLastDate ; |
---|
| 473 | } |
---|
| 474 | |
---|
| 475 | if (!split_end_offset.isEmpty()) splitEnd = splitEnd + split_end_offset; |
---|
| 476 | else splitEnd = splitEnd - 1 * Second; |
---|
| 477 | |
---|
[651] | 478 | string splitFormat; |
---|
[431] | 479 | if (split_freq_format.isEmpty()) |
---|
| 480 | { |
---|
[538] | 481 | if (split_freq.getValue().second != 0) splitFormat = "%y%mo%d%h%mi%s"; |
---|
| 482 | else if (split_freq.getValue().minute != 0) splitFormat = "%y%mo%d%h%mi"; |
---|
| 483 | else if (split_freq.getValue().hour != 0) splitFormat = "%y%mo%d%h"; |
---|
| 484 | else if (split_freq.getValue().day != 0) splitFormat = "%y%mo%d"; |
---|
| 485 | else if (split_freq.getValue().month != 0) splitFormat = "%y%mo"; |
---|
| 486 | else splitFormat = "%y"; |
---|
[431] | 487 | } |
---|
[651] | 488 | else splitFormat = split_freq_format; |
---|
[702] | 489 | |
---|
[875] | 490 | oss << firstPart ; |
---|
[1201] | 491 | if (hasStartDate) oss << split_start.getStr(splitFormat) ; |
---|
[875] | 492 | oss << middlePart ; |
---|
| 493 | if (hasEndDate) oss << splitEnd.getStr(splitFormat); |
---|
| 494 | oss << lastPart ; |
---|
[702] | 495 | |
---|
[1158] | 496 | StdString keySuffix("CContext_"+CContext::getCurrent()->getId()+"::CFile_"+getFileOutputName()+"::") ; |
---|
| 497 | context->registryOut->setKey(keySuffix+"splitStart", lastSplit); |
---|
| 498 | context->registryOut->setKey(keySuffix+"splitEnd", splitEnd); |
---|
[431] | 499 | } |
---|
[875] | 500 | else oss<<firstPart<<lastPart ; |
---|
[509] | 501 | |
---|
[528] | 502 | bool append = !this->append.isEmpty() && this->append.getValue(); |
---|
[567] | 503 | |
---|
[517] | 504 | bool useClassicFormat = !format.isEmpty() && format == format_attr::netcdf4_classic; |
---|
[878] | 505 | bool useCFConvention = convention.isEmpty() || convention == convention_attr::CF; |
---|
[517] | 506 | |
---|
[651] | 507 | bool multifile = true; |
---|
[300] | 508 | if (!type.isEmpty()) |
---|
| 509 | { |
---|
[651] | 510 | if (type == type_attr::one_file) multifile = false; |
---|
| 511 | else if (type == type_attr::multiple_file) multifile = true; |
---|
[379] | 512 | |
---|
[509] | 513 | } |
---|
[379] | 514 | #ifndef USING_NETCDF_PAR |
---|
| 515 | if (!multifile) |
---|
| 516 | { |
---|
[651] | 517 | info(0) << "!!! Warning -> Using non parallel version of netcdf, switching in multiple_file mode for file : " << filename << " ..." << endl; |
---|
| 518 | multifile = true; |
---|
[379] | 519 | } |
---|
| 520 | #endif |
---|
[509] | 521 | if (multifile) |
---|
[300] | 522 | { |
---|
[651] | 523 | int commSize, commRank; |
---|
| 524 | MPI_Comm_size(fileComm, &commSize); |
---|
| 525 | MPI_Comm_rank(fileComm, &commRank); |
---|
[509] | 526 | |
---|
| 527 | if (server->intraCommSize > 1) |
---|
[375] | 528 | { |
---|
[651] | 529 | oss << "_" ; |
---|
| 530 | int width=0; int n = commSize-1; |
---|
| 531 | while (n != 0) { n = n / 10; width++;} |
---|
[509] | 532 | if (!min_digits.isEmpty()) |
---|
[651] | 533 | if (width < min_digits) width = min_digits; |
---|
| 534 | oss.width(width); |
---|
| 535 | oss.fill('0'); |
---|
| 536 | oss << right << commRank; |
---|
[375] | 537 | } |
---|
[300] | 538 | } |
---|
| 539 | oss << ".nc"; |
---|
| 540 | |
---|
[526] | 541 | bool isCollective = par_access.isEmpty() || par_access == par_access_attr::collective; |
---|
| 542 | |
---|
| 543 | if (isOpen) data_out->closeFile(); |
---|
| 544 | |
---|
[1158] | 545 | data_out = shared_ptr<CDataOutput>(new CNc4DataOutput(this, oss.str(), append, useClassicFormat, useCFConvention, |
---|
[802] | 546 | fileComm, multifile, isCollective, time_counter_name)); |
---|
[528] | 547 | isOpen = true; |
---|
[300] | 548 | |
---|
[528] | 549 | data_out->writeFile(CFile::get(this)); |
---|
| 550 | |
---|
| 551 | // Do not recreate the file structure if opening an existing file |
---|
| 552 | if (!data_out->IsInAppendMode()) |
---|
| 553 | { |
---|
| 554 | std::vector<CField*>::iterator it, end = this->enabledFields.end(); |
---|
| 555 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
| 556 | { |
---|
[347] | 557 | CField* field = *it; |
---|
[300] | 558 | this->data_out->writeFieldGrid(field); |
---|
[528] | 559 | } |
---|
| 560 | this->data_out->writeTimeDimension(); |
---|
[509] | 561 | |
---|
[528] | 562 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
| 563 | { |
---|
[347] | 564 | CField* field = *it; |
---|
[1158] | 565 | this->data_out->writeFieldTimeAxis(field); |
---|
| 566 | } |
---|
| 567 | |
---|
| 568 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
| 569 | { |
---|
| 570 | CField* field = *it; |
---|
[300] | 571 | this->data_out->writeField(field); |
---|
[528] | 572 | } |
---|
[509] | 573 | |
---|
[651] | 574 | vector<CVariable*> listVars = getAllVariables(); |
---|
[528] | 575 | for (vector<CVariable*>::iterator it = listVars.begin(); it != listVars.end(); it++) |
---|
| 576 | this->data_out->writeAttribute(*it); |
---|
[509] | 577 | |
---|
[528] | 578 | this->data_out->definition_end(); |
---|
| 579 | } |
---|
[1158] | 580 | else |
---|
| 581 | { |
---|
| 582 | // check time axis even in append mode |
---|
| 583 | std::vector<CField*>::iterator it, end = this->enabledFields.end(); |
---|
| 584 | for (it = this->enabledFields.begin(); it != end; it++) |
---|
| 585 | { |
---|
| 586 | CField* field = *it; |
---|
| 587 | this->data_out->writeFieldTimeAxis(field); |
---|
| 588 | } |
---|
| 589 | } |
---|
[219] | 590 | } |
---|
| 591 | } |
---|
| 592 | |
---|
[599] | 593 | /*! |
---|
| 594 | \brief Open an existing NetCDF file in read-only mode |
---|
| 595 | */ |
---|
[1232] | 596 | void CFile::openInReadMode() |
---|
[599] | 597 | { |
---|
| 598 | CContext* context = CContext::getCurrent(); |
---|
[651] | 599 | CContextServer* server = context->server; |
---|
[1232] | 600 | MPI_Comm readComm = this->fileComm; |
---|
[599] | 601 | |
---|
[1232] | 602 | if (!allZoneEmpty) |
---|
[599] | 603 | { |
---|
[773] | 604 | StdString filename = getFileOutputName(); |
---|
[599] | 605 | StdOStringStream oss; |
---|
| 606 | oss << filename; |
---|
| 607 | |
---|
| 608 | if (!split_freq.isEmpty()) |
---|
| 609 | { |
---|
| 610 | string splitFormat; |
---|
| 611 | if (split_freq_format.isEmpty()) |
---|
| 612 | { |
---|
| 613 | if (split_freq.getValue().second != 0) splitFormat = "%y%mo%d%h%mi%s"; |
---|
| 614 | else if (split_freq.getValue().minute != 0) splitFormat = "%y%mo%d%h%mi"; |
---|
| 615 | else if (split_freq.getValue().hour != 0) splitFormat = "%y%mo%d%h"; |
---|
| 616 | else if (split_freq.getValue().day != 0) splitFormat = "%y%mo%d"; |
---|
| 617 | else if (split_freq.getValue().month != 0) splitFormat = "%y%mo"; |
---|
| 618 | else splitFormat = "%y"; |
---|
| 619 | } |
---|
[651] | 620 | else splitFormat = split_freq_format; |
---|
| 621 | oss << "_" << lastSplit.getStr(splitFormat) |
---|
| 622 | << "-" << (lastSplit + split_freq.getValue() - 1 * Second).getStr(splitFormat); |
---|
[599] | 623 | } |
---|
| 624 | |
---|
| 625 | bool multifile = true; |
---|
| 626 | if (!type.isEmpty()) |
---|
| 627 | { |
---|
| 628 | if (type == type_attr::one_file) multifile = false; |
---|
| 629 | else if (type == type_attr::multiple_file) multifile = true; |
---|
| 630 | } |
---|
| 631 | #ifndef USING_NETCDF_PAR |
---|
| 632 | if (!multifile) |
---|
| 633 | { |
---|
| 634 | info(0) << "!!! Warning -> Using non parallel version of netcdf, switching in multiple_file mode for file : " << filename << " ..." << endl; |
---|
| 635 | multifile = true; |
---|
| 636 | } |
---|
| 637 | #endif |
---|
| 638 | if (multifile) |
---|
| 639 | { |
---|
| 640 | int commSize, commRank; |
---|
[1136] | 641 | MPI_Comm_size(readComm, &commSize); |
---|
| 642 | MPI_Comm_rank(readComm, &commRank); |
---|
[599] | 643 | |
---|
| 644 | if (server->intraCommSize > 1) |
---|
| 645 | { |
---|
[651] | 646 | oss << "_"; |
---|
[599] | 647 | int width = 0, n = commSize - 1; |
---|
| 648 | while (n != 0) { n = n / 10; width++; } |
---|
| 649 | if (!min_digits.isEmpty() && width < min_digits) |
---|
| 650 | width = min_digits; |
---|
| 651 | oss.width(width); |
---|
| 652 | oss.fill('0'); |
---|
| 653 | oss << right << commRank; |
---|
| 654 | } |
---|
| 655 | } |
---|
| 656 | oss << ".nc"; |
---|
| 657 | |
---|
| 658 | bool isCollective = par_access.isEmpty() || par_access == par_access_attr::collective; |
---|
| 659 | |
---|
| 660 | if (isOpen) data_out->closeFile(); |
---|
[1136] | 661 | if (time_counter_name.isEmpty()) data_in = shared_ptr<CDataInput>(new CNc4DataInput(oss.str(), readComm, multifile, isCollective)); |
---|
| 662 | else data_in = shared_ptr<CDataInput>(new CNc4DataInput(oss.str(), readComm, multifile, isCollective, time_counter_name)); |
---|
[599] | 663 | isOpen = true; |
---|
| 664 | } |
---|
| 665 | } |
---|
| 666 | |
---|
[509] | 667 | //! Close file |
---|
[286] | 668 | void CFile::close(void) |
---|
| 669 | { |
---|
[1232] | 670 | if (!allZoneEmpty) |
---|
[509] | 671 | if (isOpen) |
---|
[321] | 672 | { |
---|
[599] | 673 | if (mode.isEmpty() || mode.getValue() == mode_attr::write) |
---|
| 674 | this->data_out->closeFile(); |
---|
| 675 | else |
---|
| 676 | this->data_in->closeFile(); |
---|
[1232] | 677 | isOpen = false; |
---|
[321] | 678 | } |
---|
[651] | 679 | if (fileComm != MPI_COMM_NULL) MPI_Comm_free(&fileComm); |
---|
[286] | 680 | } |
---|
[219] | 681 | //---------------------------------------------------------------- |
---|
| 682 | |
---|
[775] | 683 | void CFile::readAttributesOfEnabledFieldsInReadMode() |
---|
| 684 | { |
---|
| 685 | if (enabledFields.empty()) return; |
---|
| 686 | |
---|
| 687 | // Just check file and try to open it |
---|
[805] | 688 | if (time_counter_name.isEmpty()) time_counter_name = "time_counter"; |
---|
| 689 | |
---|
[1136] | 690 | checkReadFile(); |
---|
[805] | 691 | |
---|
[775] | 692 | for (int idx = 0; idx < enabledFields.size(); ++idx) |
---|
| 693 | { |
---|
| 694 | // First of all, find out which domain and axis associated with this field |
---|
| 695 | enabledFields[idx]->solveGridReference(); |
---|
| 696 | |
---|
| 697 | // Read attributes of domain and axis from this file |
---|
| 698 | this->data_in->readFieldAttributesMetaData(enabledFields[idx]); |
---|
| 699 | |
---|
| 700 | // Now complete domain and axis associated with this field |
---|
| 701 | enabledFields[idx]->solveGenerateGrid(); |
---|
| 702 | |
---|
| 703 | // Read necessary value from file |
---|
| 704 | this->data_in->readFieldAttributesValues(enabledFields[idx]); |
---|
| 705 | |
---|
| 706 | // Fill attributes for base reference |
---|
| 707 | enabledFields[idx]->solveGridDomainAxisBaseRef(); |
---|
| 708 | } |
---|
| 709 | |
---|
| 710 | // Now everything is ok, close it |
---|
| 711 | close(); |
---|
| 712 | } |
---|
| 713 | |
---|
| 714 | |
---|
[509] | 715 | /*! |
---|
| 716 | \brief Parse xml file and write information into file object |
---|
| 717 | \param [in] node xmld node corresponding in xml file |
---|
| 718 | */ |
---|
[219] | 719 | void CFile::parse(xml::CXMLNode & node) |
---|
| 720 | { |
---|
| 721 | SuperClass::parse(node); |
---|
[509] | 722 | |
---|
[472] | 723 | if (node.goToChildElement()) |
---|
| 724 | { |
---|
| 725 | do |
---|
| 726 | { |
---|
| 727 | if (node.getElementName()=="field" || node.getElementName()=="field_group") this->getVirtualFieldGroup()->parseChild(node); |
---|
| 728 | else if (node.getElementName()=="variable" || node.getElementName()=="variable_group") this->getVirtualVariableGroup()->parseChild(node); |
---|
[651] | 729 | } while (node.goToNextElement()); |
---|
[472] | 730 | node.goToParentElement(); |
---|
[219] | 731 | } |
---|
[472] | 732 | |
---|
[219] | 733 | } |
---|
| 734 | //---------------------------------------------------------------- |
---|
| 735 | |
---|
[509] | 736 | /*! |
---|
| 737 | \brief Represent a file in form of string with all its info |
---|
| 738 | \return String |
---|
| 739 | */ |
---|
[219] | 740 | StdString CFile::toString(void) const |
---|
| 741 | { |
---|
| 742 | StdOStringStream oss; |
---|
| 743 | |
---|
| 744 | oss << "<" << CFile::GetName() << " "; |
---|
| 745 | if (this->hasId()) |
---|
| 746 | oss << " id=\"" << this->getId() << "\" "; |
---|
| 747 | oss << SuperClassAttribute::toString() << ">" << std::endl; |
---|
[347] | 748 | if (this->getVirtualFieldGroup() != NULL) |
---|
[219] | 749 | oss << *this->getVirtualFieldGroup() << std::endl; |
---|
| 750 | oss << "</" << CFile::GetName() << " >"; |
---|
| 751 | return (oss.str()); |
---|
| 752 | } |
---|
| 753 | |
---|
| 754 | //---------------------------------------------------------------- |
---|
[509] | 755 | |
---|
| 756 | /*! |
---|
| 757 | \brief Find all inheritace among objects in a file. |
---|
| 758 | \param [in] apply (true) write attributes of parent into ones of child if they are empty |
---|
| 759 | (false) write attributes of parent into a new container of child |
---|
| 760 | \param [in] parent |
---|
| 761 | */ |
---|
[445] | 762 | void CFile::solveDescInheritance(bool apply, const CAttributeMap * const parent) |
---|
[219] | 763 | { |
---|
[445] | 764 | SuperClassAttribute::setAttributes(parent,apply); |
---|
[509] | 765 | this->getVirtualFieldGroup()->solveDescInheritance(apply, NULL); |
---|
[472] | 766 | this->getVirtualVariableGroup()->solveDescInheritance(apply, NULL); |
---|
[219] | 767 | } |
---|
| 768 | |
---|
| 769 | //---------------------------------------------------------------- |
---|
| 770 | |
---|
[509] | 771 | /*! |
---|
| 772 | \brief Resolve all reference of active fields. |
---|
| 773 | In order to know exactly which data each active field has, a search for all its |
---|
| 774 | reference to find its parents or/and its base reference object must be done. Moreover |
---|
| 775 | during this search, there are some information that can only be sent to server AFTER |
---|
| 776 | all information of active fields are created on server side, e.g: checking mask or index |
---|
| 777 | \param [in] sendToServer: Send all info to server (true) or only a part of it (false) |
---|
| 778 | */ |
---|
[823] | 779 | void CFile::solveOnlyRefOfEnabledFields(bool sendToServer) |
---|
| 780 | { |
---|
| 781 | int size = this->enabledFields.size(); |
---|
| 782 | for (int i = 0; i < size; ++i) |
---|
| 783 | { |
---|
[1129] | 784 | this->enabledFields[i]->solveOnlyReferenceEnabledField(sendToServer); |
---|
[823] | 785 | } |
---|
| 786 | } |
---|
| 787 | |
---|
[1025] | 788 | void CFile::checkGridOfEnabledFields() |
---|
| 789 | { |
---|
| 790 | int size = this->enabledFields.size(); |
---|
| 791 | for (int i = 0; i < size; ++i) |
---|
| 792 | { |
---|
| 793 | this->enabledFields[i]->checkGridOfEnabledFields(); |
---|
| 794 | } |
---|
| 795 | } |
---|
| 796 | |
---|
[1239] | 797 | void CFile::sendGridComponentOfEnabledFields() |
---|
| 798 | { |
---|
| 799 | int size = this->enabledFields.size(); |
---|
| 800 | for (int i = 0; i < size; ++i) |
---|
| 801 | { |
---|
| 802 | this->enabledFields[i]->sendGridComponentOfEnabledFields(); |
---|
| 803 | } |
---|
| 804 | } |
---|
| 805 | |
---|
[1025] | 806 | void CFile::sendGridOfEnabledFields() |
---|
| 807 | { |
---|
| 808 | int size = this->enabledFields.size(); |
---|
| 809 | for (int i = 0; i < size; ++i) |
---|
| 810 | { |
---|
| 811 | this->enabledFields[i]->sendGridOfEnabledFields(); |
---|
| 812 | } |
---|
| 813 | } |
---|
| 814 | |
---|
[823] | 815 | void CFile::generateNewTransformationGridDest() |
---|
| 816 | { |
---|
| 817 | int size = this->enabledFields.size(); |
---|
| 818 | for (int i = 0; i < size; ++i) |
---|
| 819 | { |
---|
| 820 | this->enabledFields[i]->generateNewTransformationGridDest(); |
---|
| 821 | } |
---|
| 822 | } |
---|
| 823 | |
---|
| 824 | /*! |
---|
| 825 | \brief Resolve all reference of active fields. |
---|
| 826 | In order to know exactly which data each active field has, a search for all its |
---|
| 827 | reference to find its parents or/and its base reference object must be done. Moreover |
---|
| 828 | during this search, there are some information that can only be sent to server AFTER |
---|
| 829 | all information of active fields are created on server side, e.g: checking mask or index |
---|
| 830 | \param [in] sendToServer: Send all info to server (true) or only a part of it (false) |
---|
| 831 | */ |
---|
[1129] | 832 | void CFile::solveAllRefOfEnabledFieldsAndTransform(bool sendToServer) |
---|
[459] | 833 | { |
---|
[509] | 834 | int size = this->enabledFields.size(); |
---|
| 835 | for (int i = 0; i < size; ++i) |
---|
[1144] | 836 | { |
---|
[1129] | 837 | this->enabledFields[i]->solveAllEnabledFieldsAndTransform(); |
---|
[509] | 838 | } |
---|
[459] | 839 | } |
---|
[509] | 840 | |
---|
| 841 | /*! |
---|
[640] | 842 | * Constructs the filter graph for each active field. |
---|
| 843 | * |
---|
| 844 | * \param gc the garbage collector to use when building the filter graph |
---|
| 845 | */ |
---|
| 846 | void CFile::buildFilterGraphOfEnabledFields(CGarbageCollector& gc) |
---|
| 847 | { |
---|
| 848 | int size = this->enabledFields.size(); |
---|
| 849 | for (int i = 0; i < size; ++i) |
---|
| 850 | { |
---|
| 851 | this->enabledFields[i]->buildFilterGraph(gc, true); |
---|
| 852 | } |
---|
| 853 | } |
---|
| 854 | |
---|
| 855 | /*! |
---|
[598] | 856 | Prefetching the data for enabled fields read from file. |
---|
| 857 | */ |
---|
| 858 | void CFile::prefetchEnabledReadModeFields(void) |
---|
| 859 | { |
---|
| 860 | if (mode.isEmpty() || mode.getValue() != mode_attr::read) |
---|
| 861 | return; |
---|
| 862 | |
---|
| 863 | int size = this->enabledFields.size(); |
---|
| 864 | for (int i = 0; i < size; ++i) |
---|
[1021] | 865 | this->enabledFields[i]->sendReadDataRequest(CContext::getCurrent()->getCalendar()->getCurrentDate()); |
---|
[598] | 866 | } |
---|
| 867 | |
---|
| 868 | /*! |
---|
| 869 | Prefetching the data for enabled fields read from file whose data is out-of-date. |
---|
| 870 | */ |
---|
| 871 | void CFile::prefetchEnabledReadModeFieldsIfNeeded(void) |
---|
| 872 | { |
---|
| 873 | if (mode.isEmpty() || mode.getValue() != mode_attr::read) |
---|
| 874 | return; |
---|
| 875 | |
---|
| 876 | int size = this->enabledFields.size(); |
---|
| 877 | for (int i = 0; i < size; ++i) |
---|
| 878 | this->enabledFields[i]->sendReadDataRequestIfNeeded(); |
---|
| 879 | } |
---|
| 880 | |
---|
[445] | 881 | void CFile::solveFieldRefInheritance(bool apply) |
---|
[219] | 882 | { |
---|
[878] | 883 | // Rsolution des hritages par rfrence de chacun des champs contenus dans le fichier. |
---|
[347] | 884 | std::vector<CField*> allF = this->getAllFields(); |
---|
[219] | 885 | for (unsigned int i = 0; i < allF.size(); i++) |
---|
[445] | 886 | allF[i]->solveRefInheritance(apply); |
---|
[219] | 887 | } |
---|
| 888 | |
---|
| 889 | //---------------------------------------------------------------- |
---|
| 890 | |
---|
[509] | 891 | /*! |
---|
| 892 | \brief Add a field into file. |
---|
| 893 | A field is added into file and it will be written out if the file is enabled and |
---|
| 894 | level of this field is smaller than level_output. A new field won't be created if one |
---|
| 895 | with id has already existed |
---|
| 896 | \param [in] id String identity of new field |
---|
| 897 | \return Pointer to added (or already existed) field |
---|
| 898 | */ |
---|
[347] | 899 | CField* CFile::addField(const string& id) |
---|
[300] | 900 | { |
---|
[651] | 901 | return vFieldGroup->createChild(id); |
---|
[300] | 902 | } |
---|
[219] | 903 | |
---|
[509] | 904 | /*! |
---|
| 905 | \brief Add a field group into file. |
---|
| 906 | A field group is added into file and it will play a role as parents for fields. |
---|
| 907 | A new field group won't be created if one with id has already existed |
---|
| 908 | \param [in] id String identity of new field group |
---|
| 909 | \return Pointer to added (or already existed) field group |
---|
| 910 | */ |
---|
[347] | 911 | CFieldGroup* CFile::addFieldGroup(const string& id) |
---|
[300] | 912 | { |
---|
[651] | 913 | return vFieldGroup->createChildGroup(id); |
---|
[300] | 914 | } |
---|
[509] | 915 | |
---|
| 916 | /*! |
---|
| 917 | \brief Add a variable into file. |
---|
| 918 | A variable is added into file and if one with id has already existed, pointer to |
---|
| 919 | it will be returned. |
---|
| 920 | Variable as long as attributes are information container of file. |
---|
| 921 | However, whereas attributes are "fixed" information, variables provides a more flexible way to user |
---|
| 922 | to fill in (extra) information for a file. |
---|
| 923 | \param [in] id String identity of new variable |
---|
| 924 | \return Pointer to added (or already existed) variable |
---|
| 925 | */ |
---|
[472] | 926 | CVariable* CFile::addVariable(const string& id) |
---|
| 927 | { |
---|
[651] | 928 | return vVariableGroup->createChild(id); |
---|
[472] | 929 | } |
---|
| 930 | |
---|
[509] | 931 | /*! |
---|
| 932 | \brief Add a variable group into file. |
---|
| 933 | A variable group is added into file and it will play a role as parents for variables. |
---|
| 934 | A new variable group won't be created if one with id has already existed |
---|
| 935 | \param [in] id String identity of new variable group |
---|
| 936 | \return Pointer to added (or already existed) variable group |
---|
| 937 | */ |
---|
[472] | 938 | CVariableGroup* CFile::addVariableGroup(const string& id) |
---|
| 939 | { |
---|
[651] | 940 | return vVariableGroup->createChildGroup(id); |
---|
[472] | 941 | } |
---|
[509] | 942 | |
---|
[1021] | 943 | void CFile::setContextClient(CContextClient* newContextClient) |
---|
| 944 | { |
---|
| 945 | client = newContextClient; |
---|
[1294] | 946 | size_t size = this->enabledFields.size(); |
---|
| 947 | for (size_t i = 0; i < size; ++i) |
---|
| 948 | { |
---|
| 949 | this->enabledFields[i]->setContextClient(newContextClient); |
---|
| 950 | } |
---|
[1021] | 951 | } |
---|
| 952 | |
---|
| 953 | CContextClient* CFile::getContextClient() |
---|
| 954 | { |
---|
| 955 | return client; |
---|
| 956 | } |
---|
| 957 | |
---|
[1232] | 958 | void CFile::setReadContextClient(CContextClient* readContextclient) |
---|
| 959 | { |
---|
| 960 | read_client = readContextclient; |
---|
| 961 | } |
---|
| 962 | |
---|
| 963 | CContextClient* CFile::getReadContextClient() |
---|
| 964 | { |
---|
| 965 | return read_client; |
---|
| 966 | } |
---|
| 967 | |
---|
[509] | 968 | /*! |
---|
| 969 | \brief Send a message to create a field on server side |
---|
| 970 | \param[in] id String identity of field that will be created on server |
---|
| 971 | */ |
---|
[1021] | 972 | void CFile::sendAddField(const string& id, CContextClient* client) |
---|
[1009] | 973 | { |
---|
[1021] | 974 | sendAddItem(id, EVENT_ID_ADD_FIELD, client); |
---|
[1009] | 975 | } |
---|
| 976 | |
---|
[509] | 977 | /*! |
---|
| 978 | \brief Send a message to create a field group on server side |
---|
| 979 | \param[in] id String identity of field group that will be created on server |
---|
| 980 | */ |
---|
[1136] | 981 | void CFile::sendAddFieldGroup(const string& id, CContextClient* client) |
---|
| 982 | { |
---|
| 983 | sendAddItem(id, (int)EVENT_ID_ADD_FIELD_GROUP, client); |
---|
| 984 | } |
---|
| 985 | |
---|
| 986 | /*! |
---|
[509] | 987 | \brief Receive a message annoucing the creation of a field on server side |
---|
| 988 | \param[in] event Received event |
---|
| 989 | */ |
---|
[300] | 990 | void CFile::recvAddField(CEventServer& event) |
---|
| 991 | { |
---|
[509] | 992 | |
---|
[651] | 993 | CBufferIn* buffer = event.subEvents.begin()->buffer; |
---|
[300] | 994 | string id; |
---|
[651] | 995 | *buffer>>id; |
---|
| 996 | get(id)->recvAddField(*buffer); |
---|
[300] | 997 | } |
---|
[509] | 998 | |
---|
| 999 | /*! |
---|
| 1000 | \brief Receive a message annoucing the creation of a field on server side |
---|
| 1001 | \param[in] buffer Buffer containing message |
---|
| 1002 | */ |
---|
[300] | 1003 | void CFile::recvAddField(CBufferIn& buffer) |
---|
| 1004 | { |
---|
[651] | 1005 | string id; |
---|
| 1006 | buffer>>id; |
---|
| 1007 | addField(id); |
---|
[300] | 1008 | } |
---|
| 1009 | |
---|
[509] | 1010 | /*! |
---|
| 1011 | \brief Receive a message annoucing the creation of a field group on server side |
---|
| 1012 | \param[in] event Received event |
---|
| 1013 | */ |
---|
[300] | 1014 | void CFile::recvAddFieldGroup(CEventServer& event) |
---|
| 1015 | { |
---|
[509] | 1016 | |
---|
[651] | 1017 | CBufferIn* buffer = event.subEvents.begin()->buffer; |
---|
[300] | 1018 | string id; |
---|
[651] | 1019 | *buffer>>id; |
---|
| 1020 | get(id)->recvAddFieldGroup(*buffer); |
---|
[300] | 1021 | } |
---|
[509] | 1022 | |
---|
| 1023 | /*! |
---|
| 1024 | \brief Receive a message annoucing the creation of a field group on server side |
---|
| 1025 | \param[in] buffer Buffer containing message |
---|
| 1026 | */ |
---|
[300] | 1027 | void CFile::recvAddFieldGroup(CBufferIn& buffer) |
---|
| 1028 | { |
---|
[651] | 1029 | string id; |
---|
| 1030 | buffer>>id; |
---|
| 1031 | addFieldGroup(id); |
---|
[300] | 1032 | } |
---|
| 1033 | |
---|
[509] | 1034 | /*! |
---|
| 1035 | \brief Send messages to duplicate all variables on server side |
---|
| 1036 | Because each variable has also its attributes. So first thing to do is replicate |
---|
| 1037 | all these attributes on server side. Because variable can have a value, the second thing |
---|
| 1038 | is to duplicate this value on server, too. |
---|
| 1039 | */ |
---|
[1021] | 1040 | void CFile::sendAddAllVariables(CContextClient* client) |
---|
[1009] | 1041 | { |
---|
| 1042 | std::vector<CVariable*> allVar = getAllVariables(); |
---|
| 1043 | std::vector<CVariable*>::const_iterator it = allVar.begin(); |
---|
| 1044 | std::vector<CVariable*>::const_iterator itE = allVar.end(); |
---|
| 1045 | |
---|
| 1046 | for (; it != itE; ++it) |
---|
| 1047 | { |
---|
[1021] | 1048 | this->sendAddVariable((*it)->getId(), client); |
---|
| 1049 | (*it)->sendAllAttributesToServer(client); |
---|
| 1050 | (*it)->sendValue(client); |
---|
[1009] | 1051 | } |
---|
| 1052 | } |
---|
| 1053 | |
---|
[509] | 1054 | /*! |
---|
[1009] | 1055 | \brief Send a message to create a variable group on server side |
---|
| 1056 | \param[in] id String identity of variable group that will be created on server |
---|
[1132] | 1057 | \param [in] client client to which we will send this adding action |
---|
| 1058 | */ |
---|
| 1059 | void CFile::sendAddVariableGroup(const string& id, CContextClient* client) |
---|
| 1060 | { |
---|
| 1061 | sendAddItem(id, (int)EVENT_ID_ADD_VARIABLE_GROUP, client); |
---|
| 1062 | } |
---|
| 1063 | |
---|
| 1064 | /* |
---|
| 1065 | Send message to add a variable into a file within a certain client |
---|
| 1066 | \param [in] id String identity of a variable |
---|
| 1067 | \param [in] client client to which we will send this adding action |
---|
| 1068 | */ |
---|
[1021] | 1069 | void CFile::sendAddVariable(const string& id, CContextClient* client) |
---|
[472] | 1070 | { |
---|
[1130] | 1071 | sendAddItem(id, (int)EVENT_ID_ADD_VARIABLE, client); |
---|
[472] | 1072 | } |
---|
[509] | 1073 | |
---|
| 1074 | /*! |
---|
| 1075 | \brief Receive a message annoucing the creation of a variable on server side |
---|
| 1076 | \param[in] event Received event |
---|
| 1077 | */ |
---|
[472] | 1078 | void CFile::recvAddVariable(CEventServer& event) |
---|
| 1079 | { |
---|
[509] | 1080 | |
---|
[651] | 1081 | CBufferIn* buffer = event.subEvents.begin()->buffer; |
---|
[472] | 1082 | string id; |
---|
[651] | 1083 | *buffer>>id; |
---|
| 1084 | get(id)->recvAddVariable(*buffer); |
---|
[472] | 1085 | } |
---|
[509] | 1086 | |
---|
| 1087 | /*! |
---|
| 1088 | \brief Receive a message annoucing the creation of a variable on server side |
---|
| 1089 | \param[in] buffer Buffer containing message |
---|
| 1090 | */ |
---|
[472] | 1091 | void CFile::recvAddVariable(CBufferIn& buffer) |
---|
| 1092 | { |
---|
[651] | 1093 | string id; |
---|
| 1094 | buffer>>id; |
---|
| 1095 | addVariable(id); |
---|
[472] | 1096 | } |
---|
| 1097 | |
---|
[509] | 1098 | /*! |
---|
| 1099 | \brief Receive a message annoucing the creation of a variable group on server side |
---|
| 1100 | \param[in] event Received event |
---|
| 1101 | */ |
---|
[472] | 1102 | void CFile::recvAddVariableGroup(CEventServer& event) |
---|
| 1103 | { |
---|
[509] | 1104 | |
---|
[651] | 1105 | CBufferIn* buffer = event.subEvents.begin()->buffer; |
---|
[472] | 1106 | string id; |
---|
[651] | 1107 | *buffer>>id; |
---|
| 1108 | get(id)->recvAddVariableGroup(*buffer); |
---|
[472] | 1109 | } |
---|
[509] | 1110 | |
---|
| 1111 | /*! |
---|
| 1112 | \brief Receive a message annoucing the creation of a variable group on server side |
---|
| 1113 | \param[in] buffer Buffer containing message |
---|
| 1114 | */ |
---|
[472] | 1115 | void CFile::recvAddVariableGroup(CBufferIn& buffer) |
---|
| 1116 | { |
---|
[651] | 1117 | string id; |
---|
| 1118 | buffer>>id; |
---|
| 1119 | addVariableGroup(id); |
---|
[472] | 1120 | } |
---|
| 1121 | |
---|
[509] | 1122 | /*! |
---|
| 1123 | \brief Sending all active (enabled) fields from client to server. |
---|
| 1124 | Each field is identified uniquely by its string identity. Not only should we |
---|
| 1125 | send the id to server but also we need to send ids of reference domain and reference axis. |
---|
| 1126 | With these two id, it's easier to make reference to grid where all data should be written. |
---|
| 1127 | Remark: This function must be called AFTER all active (enabled) files have been created on the server side |
---|
[1136] | 1128 | */ |
---|
| 1129 | void CFile::sendEnabledFields(CContextClient* client) |
---|
[1009] | 1130 | { |
---|
| 1131 | size_t size = this->enabledFields.size(); |
---|
| 1132 | for (size_t i = 0; i < size; ++i) |
---|
| 1133 | { |
---|
| 1134 | CField* field = this->enabledFields[i]; |
---|
[1021] | 1135 | this->sendAddField(field->getId(), client); |
---|
[1278] | 1136 | field->checkAttributes(); |
---|
[1021] | 1137 | field->sendAllAttributesToServer(client); |
---|
| 1138 | field->sendAddAllVariables(client); |
---|
[1009] | 1139 | } |
---|
| 1140 | } |
---|
| 1141 | |
---|
[1021] | 1142 | |
---|
[509] | 1143 | /*! |
---|
| 1144 | \brief Dispatch event received from client |
---|
| 1145 | Whenever a message is received in buffer of server, it will be processed depending on |
---|
| 1146 | its event type. A new event type should be added in the switch list to make sure |
---|
| 1147 | it processed on server side. |
---|
| 1148 | \param [in] event: Received message |
---|
| 1149 | */ |
---|
[300] | 1150 | bool CFile::dispatchEvent(CEventServer& event) |
---|
| 1151 | { |
---|
[651] | 1152 | if (SuperClass::dispatchEvent(event)) return true; |
---|
[300] | 1153 | else |
---|
| 1154 | { |
---|
| 1155 | switch(event.type) |
---|
| 1156 | { |
---|
| 1157 | case EVENT_ID_ADD_FIELD : |
---|
[651] | 1158 | recvAddField(event); |
---|
| 1159 | return true; |
---|
| 1160 | break; |
---|
[509] | 1161 | |
---|
[300] | 1162 | case EVENT_ID_ADD_FIELD_GROUP : |
---|
[651] | 1163 | recvAddFieldGroup(event); |
---|
| 1164 | return true; |
---|
| 1165 | break; |
---|
[509] | 1166 | |
---|
[472] | 1167 | case EVENT_ID_ADD_VARIABLE : |
---|
[651] | 1168 | recvAddVariable(event); |
---|
| 1169 | return true; |
---|
| 1170 | break; |
---|
[509] | 1171 | |
---|
[472] | 1172 | case EVENT_ID_ADD_VARIABLE_GROUP : |
---|
[651] | 1173 | recvAddVariableGroup(event); |
---|
| 1174 | return true; |
---|
| 1175 | break; |
---|
[300] | 1176 | default : |
---|
[651] | 1177 | ERROR("bool CFile::dispatchEvent(CEventServer& event)", << "Unknown Event"); |
---|
| 1178 | return false; |
---|
[300] | 1179 | } |
---|
| 1180 | } |
---|
| 1181 | } |
---|
[509] | 1182 | |
---|
| 1183 | |
---|
| 1184 | |
---|
| 1185 | |
---|
[219] | 1186 | ///--------------------------------------------------------------- |
---|
| 1187 | |
---|
[335] | 1188 | } // namespace xios |
---|