openstudio::FileReference Class Reference

#include <FileReference.hpp>

Public Member Functions
Constructors and Destructors
	FileReference (const openstudio::path &p)
	FileReference (const openstudio::UUID &uuid, const openstudio::UUID &versionUUID, const std::string &name, const std::string &displayName, const std::string &description, const openstudio::path &p, const FileReferenceType &fileType, const DateTime &timestampLast, const std::string &checksumCreate, const std::string &checksumLast)
	De-serialization constructor.
virtual	~FileReference ()=default
FileReference	clone () const
Getters
openstudio::UUID	uuid () const
openstudio::UUID	versionUUID () const
std::string	name () const
std::string	displayName () const
std::string	description () const
openstudio::path	path () const
FileReferenceType	fileType () const
DateTime	timestampLast () const
	Last modified time of this file, or time object was created if path does not actually exist on the file system.
std::string	checksumCreate () const
	Checksum at time this object was created, if file exists.
std::string	checksumLast () const

Related Symbols
(Note that these are not member symbols.)
using	FileReferenceVector = std::vector<FileReference>
using	OptionalFileReference = boost::optional<FileReference>

Setters
void	setName (const std::string &newName)
void	setDisplayName (const std::string &newDisplayName)
void	setDescription (const std::string &newDescription)
void	setPath (const openstudio::path &newPath)
bool	makePathAbsolute (const openstudio::path &searchDirectory)
bool	makePathRelative (const openstudio::path &basePath=openstudio::path())
	Save the path as relative to basePath, or just keep the file name and extension if basePath.empty().
bool	update (const openstudio::path &searchDirectory)
	Returns true and updates timestampLast and checksumLast if file is located.

Constructor & Destructor Documentation

FileReference() [1/2]

openstudio::FileReference::FileReference ( const openstudio::path & p )

explicit

FileReference() [2/2]

openstudio::FileReference::FileReference	(	const openstudio::UUID &	uuid,
		const openstudio::UUID &	versionUUID,
		const std::string &	name,
		const std::string &	displayName,
		const std::string &	description,
		const openstudio::path &	p,
		const FileReferenceType &	fileType,
		const DateTime &	timestampLast,
		const std::string &	checksumCreate,
		const std::string &	checksumLast )

De-serialization constructor.

Not for general use.

~FileReference()

virtual openstudio::FileReference::~FileReference ( )

virtualdefault

Member Function Documentation

checksumCreate()

std::string openstudio::FileReference::checksumCreate

(

)

const

Checksum at time this object was created, if file exists.

Otherwise "00000000".

checksumLast()

std::string openstudio::FileReference::checksumLast

(

)

const

clone()

FileReference openstudio::FileReference::clone

(

)

const

description()

std::string openstudio::FileReference::description

(

)

const

displayName()

std::string openstudio::FileReference::displayName

(

)

const

fileType()

FileReferenceType openstudio::FileReference::fileType

(

)

const

makePathAbsolute()

bool openstudio::FileReference::makePathAbsolute

(

const openstudio::path &

searchDirectory

)

makePathRelative()

bool openstudio::FileReference::makePathRelative

(

const openstudio::path &

basePath = openstudio::path()

)

Save the path as relative to basePath, or just keep the file name and extension if basePath.empty().

name()

std::string openstudio::FileReference::name

(

)

const

path()

openstudio::path openstudio::FileReference::path

(

)

const

setDescription()

void openstudio::FileReference::setDescription

(

const std::string &

newDescription

)

setDisplayName()

void openstudio::FileReference::setDisplayName

(

const std::string &

newDisplayName

)

setName()

void openstudio::FileReference::setName

(

const std::string &

newName

)

setPath()

void openstudio::FileReference::setPath

(

const openstudio::path &

newPath

)

timestampLast()

DateTime openstudio::FileReference::timestampLast

(

)

const

Last modified time of this file, or time object was created if path does not actually exist on the file system.

update()

bool openstudio::FileReference::update

(

const openstudio::path &

searchDirectory

)

Returns true and updates timestampLast and checksumLast if file is located.

uuid()

openstudio::UUID openstudio::FileReference::uuid

(

)

const

versionUUID()

openstudio::UUID openstudio::FileReference::versionUUID

(

)

const

Friends And Related Symbol Documentation

FileReferenceVector

using FileReferenceVector = std::vector<FileReference>

related

OptionalFileReference

using OptionalFileReference = boost::optional<FileReference>

related