2020-09-02 09:42:51 +02:00
<!-- HTML header for doxygen 1.8.18 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2021-01-26 11:28:50 +01:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2020-09-02 09:42:51 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2021-04-27 23:00:03 +02:00
< title > OR-Tools: message_callback_data.cc Source File< / title >
2020-09-02 09:42:51 +02:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "styleSheet.tmp.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "orLogo.png" / > < / td >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > OR-Tools
2021-04-27 23:00:03 +02:00
  < span id = "projectnumber" > 9.0< / span >
2020-09-02 09:42:51 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-01-26 11:28:50 +01:00
<!-- Generated by Doxygen 1.9.1 -->
2020-09-02 09:42:51 +02:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-01-26 11:28:50 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2020-09-02 09:42:51 +02:00
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-04-27 23:00:03 +02:00
$(document).ready(function(){initNavTree('message__callback__data_8cc_source.html',''); initResizable(); });
2020-09-02 09:42:51 +02:00
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "headertitle" >
2021-04-27 23:00:03 +02:00
< div class = "title" > message_callback_data.cc< / div > < / div >
2020-09-02 09:42:51 +02:00
< / div > <!-- header -->
< div class = "contents" >
2021-04-27 23:00:03 +02:00
< a href = "message__callback__data_8cc.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > // Copyright 2010-2021 Google LLC< / span > < / div >
2020-09-02 09:42:51 +02:00
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "comment" > // Licensed under the Apache License, Version 2.0 (the " License" );< / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < span class = "comment" > // you may not use this file except in compliance with the License.< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > // You may obtain a copy of the License at< / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > //< / span > < / div >
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "comment" > // http://www.apache.org/licenses/LICENSE-2.0< / span > < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "comment" > //< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "comment" > // Unless required by applicable law or agreed to in writing, software< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < span class = "comment" > // distributed under the License is distributed on an " AS IS" BASIS,< / span > < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "comment" > // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.< / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "comment" > // See the License for the specific language governing permissions and< / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "comment" > // limitations under the License.< / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < / div >
2021-04-27 23:00:03 +02:00
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "message__callback__data_8h.html" > ortools/math_opt/solvers/message_callback_data.h< / a > " < / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "preprocessor" > #include < cstddef> < / span > < / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "preprocessor" > #include < string> < / span > < / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < span class = "preprocessor" > #include < utility> < / span > < / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   < / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < span class = "preprocessor" > #include " absl/strings/string_view.h" < / span > < / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "preprocessor" > #include " absl/types/optional.h" < / span > < / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < span class = "preprocessor" > #include " ortools/math_opt/callback.pb.h" < / span > < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < span class = "keyword" > namespace < / span > < a class = "code" href = "namespaceoperations__research.html" > operations_research< / a > {< / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < span class = "keyword" > namespace < / span > math_opt {< / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > < a class = "line" href = "classoperations__research_1_1math__opt_1_1_message_callback_data.html#a1bb167564d01c2c7e0d7a6c56b51178e" > 27< / a > < / span >   absl::optional< CallbackDataProto> < a class = "code" href = "classoperations__research_1_1math__opt_1_1_message_callback_data.html#a1bb167564d01c2c7e0d7a6c56b51178e" > MessageCallbackData::Parse< / a > (< / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "keyword" > const< / span > absl::string_view < a class = "code" href = "trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879" > message< / a > ) {< / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   CallbackDataProto data;< / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < span class = "comment" > // Iterate on all complete lines (lines ending with a ' \n' ).< / span > < / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   absl::string_view remainder = < a class = "code" href = "trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879" > message< / a > ;< / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < span class = "keywordflow" > for< / span > (std::size_t end = 0; end = remainder.find(< span class = "charliteral" > ' \n' < / span > ), end != remainder.npos;< / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   remainder = remainder.substr(end + 1)) {< / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < span class = "keyword" > const< / span > < span class = "keyword" > auto< / span > line = remainder.substr(0, end);< / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   < span class = "keywordflow" > if< / span > (!unfinished_line_.empty()) {< / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   std::string& new_message = *data.add_messages();< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   new_message = std::move(unfinished_line_);< / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   unfinished_line_.clear();< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   new_message += line;< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   } < span class = "keywordflow" > else< / span > {< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   data.add_messages(std::string(line));< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   }< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   }< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "comment" > // At the end of the loop, the remainder may contains the last unfinished< / span > < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "comment" > // line. This could be the first line too if the entire message does not< / span > < / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < span class = "comment" > // contain ' \n' .< / span > < / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   unfinished_line_ += remainder;< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < span class = "comment" > // It is an error to call the user callback without any message.< / span > < / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "keywordflow" > if< / span > (data.messages().empty()) {< / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "keywordflow" > return< / span > absl::nullopt;< / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   }< / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   < / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < span class = "comment" > // We only need to set that if we have messages.< / span > < / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   data.set_event(CALLBACK_EVENT_MESSAGE);< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   < / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < span class = "keywordflow" > return< / span > data;< / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   }< / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   < / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > < a class = "line" href = "classoperations__research_1_1math__opt_1_1_message_callback_data.html#a8caf07a427bdefa52380ed652d3428ae" > 62< / a > < / span >   absl::optional< CallbackDataProto> < a class = "code" href = "classoperations__research_1_1math__opt_1_1_message_callback_data.html#a8caf07a427bdefa52380ed652d3428ae" > MessageCallbackData::Flush< / a > () {< / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > 63< / span >   < span class = "keywordflow" > if< / span > (unfinished_line_.empty()) {< / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   < span class = "keywordflow" > return< / span > absl::nullopt;< / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   }< / div >
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   < / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   CallbackDataProto data;< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   data.set_event(CALLBACK_EVENT_MESSAGE);< / div >
< div class = "line" > < a name = "l00069" > < / a > < span class = "lineno" > 69< / span >   *data.add_messages() = std::move(unfinished_line_);< / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   unfinished_line_.clear();< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   < span class = "keywordflow" > return< / span > data;< / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   }< / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   < / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   } < span class = "comment" > // namespace math_opt< / span > < / div >
< div class = "line" > < a name = "l00075" > < / a > < span class = "lineno" > 75< / span >   } < span class = "comment" > // namespace operations_research< / span > < / div >
< div class = "ttc" id = "aclassoperations__research_1_1math__opt_1_1_message_callback_data_html_a1bb167564d01c2c7e0d7a6c56b51178e" > < div class = "ttname" > < a href = "classoperations__research_1_1math__opt_1_1_message_callback_data.html#a1bb167564d01c2c7e0d7a6c56b51178e" > operations_research::math_opt::MessageCallbackData::Parse< / a > < / div > < div class = "ttdeci" > absl::optional< CallbackDataProto > Parse(absl::string_view message)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "message__callback__data_8cc_source.html#l00027" > message_callback_data.cc:27< / a > < / div > < / div >
< div class = "ttc" id = "aclassoperations__research_1_1math__opt_1_1_message_callback_data_html_a8caf07a427bdefa52380ed652d3428ae" > < div class = "ttname" > < a href = "classoperations__research_1_1math__opt_1_1_message_callback_data.html#a8caf07a427bdefa52380ed652d3428ae" > operations_research::math_opt::MessageCallbackData::Flush< / a > < / div > < div class = "ttdeci" > absl::optional< CallbackDataProto > Flush()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "message__callback__data_8cc_source.html#l00062" > message_callback_data.cc:62< / a > < / div > < / div >
< div class = "ttc" id = "amessage__callback__data_8h_html" > < div class = "ttname" > < a href = "message__callback__data_8h.html" > message_callback_data.h< / a > < / div > < / div >
< div class = "ttc" id = "anamespaceoperations__research_html" > < div class = "ttname" > < a href = "namespaceoperations__research.html" > operations_research< / a > < / div > < div class = "ttdoc" > Collection of objects used to extend the Constraint Solver library.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "dense__doubly__linked__list_8h_source.html#l00021" > dense_doubly_linked_list.h:21< / a > < / div > < / div >
< div class = "ttc" id = "atrace_8cc_html_a36bd74109f547f7f8198faf5a12d2879" > < div class = "ttname" > < a href = "trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879" > message< / a > < / div > < div class = "ttdeci" > std::string message< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "trace_8cc_source.html#l00398" > trace.cc:398< / a > < / div > < / div >
2021-01-26 11:28:50 +01:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2020-09-02 09:42:51 +02:00
<!-- HTML footer for doxygen 1.8.18 -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2021-04-27 23:00:03 +02:00
< li class = "navelem" > < a class = "el" href = "dir_a7cc1eeded8f693d0da6c729bc88c45a.html" > ortools< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_1defc00030ff81d309105e053121082f.html" > math_opt< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_6a51feaf2b7f0a1d5cfa932e9ba3d2cd.html" > solvers< / a > < / li > < li class = "navelem" > < a class = "el" href = "message__callback__data_8cc.html" > message_callback_data.cc< / a > < / li >
2020-09-02 09:42:51 +02:00
< li class = "footer" > Generated by
< a href = "http://www.doxygen.org/index.html" >
2021-01-26 11:28:50 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.9.1 < / li >
2020-09-02 09:42:51 +02:00
< / ul >
< / div >
< / body >
< / html >
