mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-03 01:59:35 -06:00
cc9a72a60b
Clean up and add documentation to MissionManager Clean up and add documentation to TimeRange Prevent a crash in DocumentationEngine when ReferencingVerifier could not be found
82 lines
3.2 KiB
C++
82 lines
3.2 KiB
C++
/*****************************************************************************************
|
|
* *
|
|
* OpenSpace *
|
|
* *
|
|
* Copyright (c) 2014-2016 *
|
|
* *
|
|
* 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. *
|
|
****************************************************************************************/
|
|
|
|
#ifndef __TIMERANGE_H__
|
|
#define __TIMERANGE_H__
|
|
|
|
#include <openspace/documentation/documentation.h>
|
|
|
|
namespace ghoul { class Dictionary; }
|
|
|
|
namespace openspace {
|
|
|
|
struct TimeRange {
|
|
|
|
/**
|
|
* Default constructor initializes an empty time range.
|
|
*/
|
|
TimeRange();
|
|
|
|
/**
|
|
* Initializes a TimeRange with both start and end time. Initializing empty timeranges
|
|
* is OK.
|
|
*/
|
|
TimeRange(double startTime, double endTime);
|
|
|
|
/**
|
|
* Throws exception if unable to parse the provided \class ghoul::Dictionary
|
|
*/
|
|
TimeRange(const ghoul::Dictionary& dict);
|
|
|
|
/**
|
|
* \returns true if timeRange could be initialized from the dictionary, false otherwise.
|
|
*/
|
|
static bool initializeFromDictionary(const ghoul::Dictionary& dict, TimeRange& timeRange);
|
|
|
|
void include(double val);
|
|
|
|
void include(const TimeRange& other);
|
|
|
|
double duration() const;
|
|
|
|
bool isDefined() const;
|
|
|
|
bool isEmpty() const;
|
|
|
|
bool inRange(double min, double max);
|
|
|
|
bool includes(double val) const;
|
|
|
|
bool includes(const TimeRange& o) const;
|
|
|
|
static openspace::Documentation Documentation();
|
|
|
|
double start;
|
|
double end;
|
|
};
|
|
|
|
} // namespace openspace
|
|
|
|
#endif //__TIMERANGE_H__
|