#include "BCLFileReference.hpp"
Public Member Functions | |
BCLFileReference (const openstudio::path &path, const bool setMembers=false) | |
virtual | ~BCLFileReference () |
openstudio::path | path () const |
std::string | checksum () const |
std::string | softwareProgram () const |
std::string | softwareProgramVersion () const |
boost::optional< VersionString > | minCompatibleVersion () const |
boost::optional< VersionString > | maxCompatibleVersion () const |
std::string | fileName () const |
std::string | fileType () const |
std::string | usageType () const |
void | setChecksum (const std::string &checksum) |
void | setSoftwareProgram (const std::string &softwareProgram) |
void | setSoftwareProgramVersion (const std::string &softwareProgramVersion) |
void | setMinCompatibleVersion (const VersionString &minCompatibleVersion) |
void | resetMinCompatibleVersion () |
void | setMaxCompatibleVersion (const VersionString &maxCompatibleVersion) |
void | resetMaxCompatibleVersion () |
void | setUsageType (const std::string &usageType) |
void | writeValues (QDomDocument &doc, QDomElement &element) const |
bool | checkForUpdate () |
Related Functions | |
std::ostream & | operator<< (std::ostream &os, const BCLFileReference &file) |
BCLFileReference is a class for tracking files that come with BCL components and measures.
|
explicit |
Constructor from file path.
|
virtual |
Virtual destructor.
bool openstudio::BCLFileReference::checkForUpdate | ( | ) |
Check if the file has been updated and return if so. Will update checksum.
std::string openstudio::BCLFileReference::checksum | ( | ) | const |
Returns the last recorded checksum.
std::string openstudio::BCLFileReference::fileName | ( | ) | const |
std::string openstudio::BCLFileReference::fileType | ( | ) | const |
boost::optional<VersionString> openstudio::BCLFileReference::maxCompatibleVersion | ( | ) | const |
boost::optional<VersionString> openstudio::BCLFileReference::minCompatibleVersion | ( | ) | const |
openstudio::path openstudio::BCLFileReference::path | ( | ) | const |
Returns path to file.
void openstudio::BCLFileReference::resetMaxCompatibleVersion | ( | ) |
void openstudio::BCLFileReference::resetMinCompatibleVersion | ( | ) |
void openstudio::BCLFileReference::setChecksum | ( | const std::string & | checksum | ) |
void openstudio::BCLFileReference::setMaxCompatibleVersion | ( | const VersionString & | maxCompatibleVersion | ) |
void openstudio::BCLFileReference::setMinCompatibleVersion | ( | const VersionString & | minCompatibleVersion | ) |
void openstudio::BCLFileReference::setSoftwareProgram | ( | const std::string & | softwareProgram | ) |
void openstudio::BCLFileReference::setSoftwareProgramVersion | ( | const std::string & | softwareProgramVersion | ) |
void openstudio::BCLFileReference::setUsageType | ( | const std::string & | usageType | ) |
std::string openstudio::BCLFileReference::softwareProgram | ( | ) | const |
std::string openstudio::BCLFileReference::softwareProgramVersion | ( | ) | const |
std::string openstudio::BCLFileReference::usageType | ( | ) | const |
void openstudio::BCLFileReference::writeValues | ( | QDomDocument & | doc, |
QDomElement & | element | ||
) | const |
|
related |
Prints BCLFileReference to os.