openstudio::BCLFileReference Class Reference

#include <BCLFileReference.hpp>

Public Member Functions
Constructors
	BCLFileReference (const openstudio::path &measureRootDir, const openstudio::path &relativePath, const bool setMembers=false)
	Constructor from file path.
Destructor
virtual	~BCLFileReference ()=default
	Virtual destructor.
Getters
openstudio::path	path () const
	Returns absolute path to file.
openstudio::path	relativePath () const
std::string	checksum () const
	Returns the last recorded checksum.
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
Setters
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)

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, const BCLFileReference &file)
	Prints BCLFileReference to os.

Operators
void	writeValues (pugi::xml_node &element) const
Json::Value	toJSON () const
std::string	toJSONString () const
bool	checkForUpdate ()
	Check if the file has been updated and return if so. Will update checksum.

Detailed Description

BCLFileReference is a class for tracking files that come with BCL components and measures.

Constructor & Destructor Documentation

BCLFileReference()

openstudio::BCLFileReference::BCLFileReference ( const openstudio::path & measureRootDir, const openstudio::path & relativePath, const bool setMembers = false )

explicit

Constructor from file path.

~BCLFileReference()

virtual openstudio::BCLFileReference::~BCLFileReference ( )

virtualdefault

Virtual destructor.

Member Function Documentation

checkForUpdate()

bool openstudio::BCLFileReference::checkForUpdate

(

)

Check if the file has been updated and return if so. Will update checksum.

checksum()

std::string openstudio::BCLFileReference::checksum

(

)

const

Returns the last recorded checksum.

fileName()

std::string openstudio::BCLFileReference::fileName

(

)

const

fileType()

std::string openstudio::BCLFileReference::fileType

(

)

const

maxCompatibleVersion()

boost::optional< VersionString > openstudio::BCLFileReference::maxCompatibleVersion

(

)

const

minCompatibleVersion()

boost::optional< VersionString > openstudio::BCLFileReference::minCompatibleVersion

(

)

const

path()

openstudio::path openstudio::BCLFileReference::path

(

)

const

Returns absolute path to file.

relativePath()

openstudio::path openstudio::BCLFileReference::relativePath

(

)

const

resetMaxCompatibleVersion()

void openstudio::BCLFileReference::resetMaxCompatibleVersion

(

)

resetMinCompatibleVersion()

void openstudio::BCLFileReference::resetMinCompatibleVersion

(

)

setChecksum()

void openstudio::BCLFileReference::setChecksum

(

const std::string &

checksum

)

setMaxCompatibleVersion()

void openstudio::BCLFileReference::setMaxCompatibleVersion

(

const VersionString &

maxCompatibleVersion

)

setMinCompatibleVersion()

void openstudio::BCLFileReference::setMinCompatibleVersion

(

const VersionString &

minCompatibleVersion

)

setSoftwareProgram()

void openstudio::BCLFileReference::setSoftwareProgram

(

const std::string &

softwareProgram

)

setSoftwareProgramVersion()

void openstudio::BCLFileReference::setSoftwareProgramVersion

(

const std::string &

softwareProgramVersion

)

setUsageType()

void openstudio::BCLFileReference::setUsageType

(

const std::string &

usageType

)

softwareProgram()

std::string openstudio::BCLFileReference::softwareProgram

(

)

const

softwareProgramVersion()

std::string openstudio::BCLFileReference::softwareProgramVersion

(

)

const

toJSON()

Json::Value openstudio::BCLFileReference::toJSON

(

)

const

toJSONString()

std::string openstudio::BCLFileReference::toJSONString

(

)

const

usageType()

std::string openstudio::BCLFileReference::usageType

(

)

const

writeValues()

void openstudio::BCLFileReference::writeValues

(

pugi::xml_node &

element

)

const

Friends And Related Symbol Documentation

operator<<()

std::ostream & operator<< ( std::ostream & os, const BCLFileReference & file )

related

Prints BCLFileReference to os.