Files
OpenSpace/modules/base/timeframe/timeframeunion.cpp
2020-02-10 21:51:01 +01:00

98 lines
4.3 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2020 *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
* software and associated documentation files (the "Software"), to deal in the Software *
* without restriction, including without limitation the rights to use, copy, modify, *
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
* permit persons to whom the Software is furnished to do so, subject to the following *
* conditions: *
* *
* The above copyright notice and this permission notice shall be included in all copies *
* or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
****************************************************************************************/
#include <modules/base/timeframe/timeframeunion.h>
#include <openspace/properties/property.h>
#include <openspace/documentation/documentation.h>
#include <openspace/documentation/verifier.h>
#include <openspace/util/spicemanager.h>
#include <openspace/util/time.h>
namespace {
constexpr const openspace::properties::Property::PropertyInfo TimeFramesInfo = {
"TimeFrames",
"Time Frames",
"A vector of time frames to combine into one. "
"The time frame is active when any of the contained time frames are, "
"but not in gaps between contained time frames."
};
} // namespace
namespace openspace {
documentation::Documentation TimeFrameUnion::Documentation() {
using namespace openspace::documentation;
return {
"Time Frame Union",
"base_time_frame_union",
{
{
TimeFramesInfo.identifier,
new TableVerifier({
{
"*",
new ReferencingVerifier("core_time_frame"),
Optional::Yes
}
}),
Optional::No,
TimeFramesInfo.description
},
}
};
}
bool TimeFrameUnion::isActive(const Time& time) const {
for (const auto& tf : _timeFrames) {
if (tf->isActive(time)) {
return true;
}
}
return false;
}
TimeFrameUnion::TimeFrameUnion(const ghoul::Dictionary& dictionary)
: TimeFrame()
{
documentation::testSpecificationAndThrow(Documentation(),
dictionary,
"TimeFrameUnion");
ghoul::Dictionary frames =
dictionary.value<ghoul::Dictionary>(TimeFramesInfo.identifier);
for (const std::string& k : frames.keys()) {
const ghoul::Dictionary& subDictionary = frames.value<ghoul::Dictionary>(k);
_timeFrames.push_back(TimeFrame::createFromDictionary(subDictionary));
TimeFrame& subFrame = *_timeFrames.back();
subFrame.setIdentifier(k);
subFrame.setGuiName(k);
subFrame.setDescription(k);
addPropertySubOwner(*_timeFrames.back());
}
}
} // namespace openspace