Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/logconfig xsd #555

Merged
merged 5 commits into from
Apr 17, 2020
Merged

Feature/logconfig xsd #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63f5c95
wip
markaren Feb 26, 2020
7ff4271
xsd for logconfig and add option for non-timestamped csv files
markaren Apr 6, 2020
e4e004b
Merge branch 'master' into feature/logconfig-xsd
markaren Apr 6, 2020
632db6c
overwrite existing files rather than append
markaren Apr 6, 2020
c8e2e4b
use append mode, no namespace, rename filename option
Apr 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions include/cse/observer/file_observer.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ class file_observer : public observer
{
std::vector<variable_description> variables;
size_t decimationFactor;
bool timeStampedFileNames;
};

simulator_logging_config parse_config(const std::string& simulatorName);
Expand Down
121 changes: 76 additions & 45 deletions src/cpp/observer/file_observer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,34 @@ std::string format_time(boost::posix_time::ptime now)
std::wstring_convert<std::codecvt_utf8<wchar_t>, wchar_t> converter;
return converter.to_bytes(wss.str());
}

void clear_file_contents_if_exists(const boost::filesystem::path& filePath, boost::filesystem::ofstream& fsw){
if (boost::filesystem::exists(filePath)) {
//clear file contents
fsw.open(filePath, std::ios_base::out | std::ios_base::trunc);
fsw.close();
}
}
} // namespace


class file_observer::slave_value_writer
{
public:
slave_value_writer(observable* observable, boost::filesystem::path& logDir)
slave_value_writer(observable* observable, boost::filesystem::path& logDir, bool timeStampedFileNames = true)
: observable_(observable)
, logDir_(logDir)
, timeStampedFileNames_(timeStampedFileNames)
{
initialize_default();
}

slave_value_writer(observable* observable, boost::filesystem::path& logDir, size_t decimationFactor,
const std::vector<variable_description>& variables)
const std::vector<variable_description>& variables, bool timeStampedFileNames = true)
: observable_(observable)
, logDir_(logDir)
, decimationFactor_(decimationFactor)
, timeStampedFileNames_(timeStampedFileNames)
{
initialize_config(variables);
}
Expand Down Expand Up @@ -147,6 +157,11 @@ class file_observer::slave_value_writer
/** Default constructor initialization, all variables are logged. */
void initialize_default()
{
if (!timeStampedFileNames_) {
const auto filePath = logDir_ / observable_->name().append(".csv");
clear_file_contents_if_exists(filePath, fsw_);
}

for (const auto& vd : observable_->model_description().variables) {
if (vd.causality != variable_causality::local) {
initialize_variable(vd);
Expand All @@ -157,19 +172,29 @@ class file_observer::slave_value_writer
/** External config initialization, only configured variables are logged. */
void initialize_config(const std::vector<variable_description>& variables)
{
if (!timeStampedFileNames_) {
const auto filePath = logDir_ / observable_->name().append(".csv");
clear_file_contents_if_exists(filePath, fsw_);
}

for (const auto& vd : variables) {
initialize_variable(vd);
}
}

void create_log_file()
{
auto time_str = format_time(boost::posix_time::microsec_clock::local_time());
auto filename = observable_->name().append("_").append(time_str).append(".csv");
std::string filename;
if (!timeStampedFileNames_) {
filename = observable_->name().append(".csv");
} else {
auto time_str = format_time(boost::posix_time::microsec_clock::local_time());
filename = observable_->name().append("_").append(time_str).append(".csv");
}

auto filepath = logDir_ / filename;
const auto filePath = logDir_ / filename;
boost::filesystem::create_directories(logDir_);
fsw_.open(filepath, std::ios_base::out | std::ios_base::app);
fsw_.open(filePath, std::ios_base::out | std::ios_base::app);

if (fsw_.fail()) {
throw std::runtime_error("Failed to open file stream for logging");
Expand Down Expand Up @@ -240,6 +265,7 @@ class file_observer::slave_value_writer
std::stringstream ss_;
std::atomic<bool> recording_ = true;
std::mutex mutex_;
bool timeStampedFileNames_ = true;
};

file_observer::file_observer(const boost::filesystem::path& logDir)
Expand Down Expand Up @@ -283,7 +309,9 @@ void file_observer::simulator_added(
// Read all configured model names from the XML. If simulator name is not in the list, do nothing.
std::vector<std::string> modelNames;
for (const auto& simulatorChild : ptree_.get_child("simulators")) {
modelNames.push_back(get_attribute<std::string>(simulatorChild.second, "name"));
if (simulatorChild.first == "simulator") {
modelNames.push_back(get_attribute<std::string>(simulatorChild.second, "name"));
}
}
if (std::find(modelNames.begin(), modelNames.end(), simulator->name()) != modelNames.end()) {
auto config = parse_config(simulator->name());
Expand All @@ -292,7 +320,8 @@ void file_observer::simulator_added(
simulator,
logDir_,
config.decimationFactor,
config.variables);
config.variables,
config.timeStampedFileNames);
} else {
return;
}
Expand Down Expand Up @@ -382,53 +411,55 @@ cse::observable* find_simulator(

file_observer::simulator_logging_config file_observer::parse_config(const std::string& simulatorName)
{
for (const auto& childElement : ptree_.get_child("simulators")) {
auto simulatorElement = childElement.second;

auto modelName = get_attribute<std::string>(simulatorElement, "name");
if (modelName == simulatorName) {
simulator_logging_config config;

config.decimationFactor = get_attribute<size_t>(simulatorElement, "decimationFactor", defaultDecimationFactor_);

const auto& simulator = find_simulator(simulators_, modelName);

if (simulatorElement.count("variable") == 0) {

for (const auto& vd : simulator->model_description().variables) {
switch (vd.type) {
case variable_type::real:
case variable_type::integer:
case variable_type::boolean:
case variable_type::string:
config.variables.push_back(vd);
break;
default:
break;
}
}
} else {
for (const auto& [variableElementName, variableElement] : simulatorElement) {
if (variableElementName == "variable") {
const auto name = get_attribute<std::string>(variableElement, "name");
const auto variableDescription =
find_variable(simulator->model_description(), name);

switch (variableDescription.type) {
auto simulators = ptree_.get_child("simulators");
bool timeStampedFileNames = simulators.get<bool>("<xmlattr>.timeStampedFileNames", true);
for (const auto& childElement : simulators) {
if (childElement.first == "simulator") {
auto simulatorElement = childElement.second;
auto modelName = get_attribute<std::string>(simulatorElement, "name");
if (modelName == simulatorName) {
simulator_logging_config config;
config.timeStampedFileNames = timeStampedFileNames;
config.decimationFactor = get_attribute<size_t>(simulatorElement, "decimationFactor", defaultDecimationFactor_);

const auto& simulator = find_simulator(simulators_, modelName);
if (simulatorElement.count("variable") == 0) {

for (const auto& vd : simulator->model_description().variables) {
switch (vd.type) {
case variable_type::real:
case variable_type::integer:
case variable_type::boolean:
case variable_type::string:
config.variables.push_back(variableDescription);
BOOST_LOG_SEV(log::logger(), log::info) << "Logging variable: " << modelName << ":" << name;
config.variables.push_back(vd);
break;
default:
CSE_PANIC_M("Variable type not supported.");
break;
}
}
} else {
for (const auto& [variableElementName, variableElement] : simulatorElement) {
if (variableElementName == "variable") {
const auto name = get_attribute<std::string>(variableElement, "name");
const auto variableDescription =
find_variable(simulator->model_description(), name);

switch (variableDescription.type) {
case variable_type::real:
case variable_type::integer:
case variable_type::boolean:
case variable_type::string:
config.variables.push_back(variableDescription);
BOOST_LOG_SEV(log::logger(), log::info) << "Logging variable: " << modelName << ":" << name;
break;
default:
CSE_PANIC_M("Variable type not supported.");
}
}
}
}
return config;
}
return config;
}
}
return simulator_logging_config();
Expand Down
9 changes: 5 additions & 4 deletions test/data/LogConfig.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<simulators>
<?xml version="1.0" encoding="UTF-8"?>

<simulators xmlns="http://opensimulationplatform.com/LogConfig">

<simulator name="slave" decimationFactor="20">
<variable name="realOut"/>
<variable name="intOut"/>
Expand All @@ -9,7 +12,5 @@
<variable name="realOut"/>
<variable name="intOut"/>
</simulator>

</simulators>
<!--simulators>
<simulator name="slave"/>
</simulators-->
27 changes: 27 additions & 0 deletions test/data/LogConfig.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="utf-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
targetNamespace="http://opensimulationplatform.com/LogConfig"
xmlns="http://opensimulationplatform.com/LogConfig">

<xs:element name="simulators" type="TSimulators"/>

<xs:complexType name="TSimulators">
<xs:sequence>
<xs:element name="simulator" type="TSimulator" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="timeStampedFileNames" type="xs:boolean" default="true"/>
</xs:complexType>

<xs:complexType name="TSimulator">
<xs:sequence>
<xs:element name="variable" type="TVariable" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="decimationFactor" type="xs:int" default="1"/>
</xs:complexType>

<xs:complexType name="TVariable">
<xs:attribute name="name" type="xs:string" use="required"/>
</xs:complexType>

</xs:schema>