openstudio::IddFileAndFactoryWrapper Class Reference

#include <IddFileAndFactoryWrapper.hpp>

Public Member Functions
Constructors and Destructors
	IddFileAndFactoryWrapper ()
	Default constructor sets IddFileType to IddFileType::OpenStudio.
	IddFileAndFactoryWrapper (const IddFile &iddFile)
	Construct from UserCustom IddFile.
	IddFileAndFactoryWrapper (IddFileType iddFileType)
	Construct wrapper that provides access to the iddFileType IddFile through the IddFactory .
Getters
std::string	version () const
	Get the file version.
std::string	header () const
	Get the file header.
std::vector< IddObject >	objects () const
	Get all the objects in the file.
std::vector< std::string >	groups () const
	Get all groups in the file (e.g.
std::vector< IddObject >	getObjectsInGroup (const std::string &group) const
	Get all the objects in group (e.g.
std::vector< IddObject >	getObjects (const boost::regex &objectRegex) const
	Get the IddObjects that match objectRegex.
boost::optional< IddObject >	versionObject () const
	If possible, returns the version IddObject for this IddFile.
boost::optional< IddObject >	getObject (const std::string &objectName) const
	Get the IddObject named objectName.
boost::optional< IddObject >	getObject (IddObjectType objectType) const
	Get the IddObject of type objectType.
std::vector< IddObject >	requiredObjects () const
	Get all IddObjects in the file that are required.
std::vector< IddObject >	uniqueObjects () const
	Get all IddObjects in the file that are marked as unique.
IddFile	iddFile () const
	Get the IddFile, which may have been explicitly specified by the user, or may be implicitly specified by reference to the IddFactory.
IddFileType	iddFileType () const
	Get the IddFileType.
Setters
void	setIddFile (const IddFile &iddFile)
	Set the IddFile explicitly.
void	setIddFile (IddFileType iddFileType)
	Set the IddFile by specifying iddFileType.

Queries
bool	isInFile (IddObjectType objectType) const
	Returns whether an IddObject of objectType is in iddFile(), unless objectType == IddObjectType::UserCustom.
bool	isInFile (const std::string &objectName) const
	Returns whether there is an IddObject named objectName in iddFile().

Detailed Description

Wraps the functionality of IddFile and IddFactory into one class for use by IdfFile and Workspace.

Constructor & Destructor Documentation

IddFileAndFactoryWrapper() [1/3]

openstudio::IddFileAndFactoryWrapper::IddFileAndFactoryWrapper

(

)

Default constructor sets IddFileType to IddFileType::OpenStudio.

IddFileAndFactoryWrapper() [2/3]

openstudio::IddFileAndFactoryWrapper::IddFileAndFactoryWrapper

(

const IddFile &

iddFile

)

Construct from UserCustom IddFile.

IddFileAndFactoryWrapper() [3/3]

openstudio::IddFileAndFactoryWrapper::IddFileAndFactoryWrapper

(

IddFileType

iddFileType

)

Construct wrapper that provides access to the iddFileType IddFile through the IddFactory .

Logs a warning if iddFileType == IddFileType::UserCustom, since this results in an empty IddFile.

Member Function Documentation

getObject() [1/2]

boost::optional< IddObject > openstudio::IddFileAndFactoryWrapper::getObject

(

const std::string &

objectName

)

const

Get the IddObject named objectName.

Return value will evaluate to false if there is no such object in the file.

getObject() [2/2]

boost::optional< IddObject > openstudio::IddFileAndFactoryWrapper::getObject

(

IddObjectType

objectType

)

const

Get the IddObject of type objectType.

Return value will evaluate to false if there is no such object in the IddFile, or if IddObjectType == IddObjectType::UserCustom.

getObjects()

std::vector< IddObject > openstudio::IddFileAndFactoryWrapper::getObjects

(

const boost::regex &

objectRegex

)

const

Get the IddObjects that match objectRegex.

getObjectsInGroup()

std::vector< IddObject > openstudio::IddFileAndFactoryWrapper::getObjectsInGroup

(

const std::string &

group

)

const

Get all the objects in group (e.g.

"Simulation Parameters").

groups()

std::vector< std::string > openstudio::IddFileAndFactoryWrapper::groups

(

)

const

Get all groups in the file (e.g.

"" and "Simulation Parameters").

header()

std::string openstudio::IddFileAndFactoryWrapper::header

(

)

const

Get the file header.

iddFile()

IddFile openstudio::IddFileAndFactoryWrapper::iddFile

(

)

const

Get the IddFile, which may have been explicitly specified by the user, or may be implicitly specified by reference to the IddFactory.

iddFileType()

IddFileType openstudio::IddFileAndFactoryWrapper::iddFileType

(

)

const

Get the IddFileType.

If iddFileType() == IddFileType::UserCustom, then the file has been explicitly specified by the user. Otherwise, the file is implicitly defined and accessed through IddFactory.

isInFile() [1/2]

bool openstudio::IddFileAndFactoryWrapper::isInFile

(

const std::string &

objectName

)

const

Returns whether there is an IddObject named objectName in iddFile().

isInFile() [2/2]

bool openstudio::IddFileAndFactoryWrapper::isInFile

(

IddObjectType

objectType

)

const

Returns whether an IddObject of objectType is in iddFile(), unless objectType == IddObjectType::UserCustom.

In the latter case, false will always be returned. To test whether a UserCustom file is being used, check the value of iddFileType().

objects()

std::vector< IddObject > openstudio::IddFileAndFactoryWrapper::objects

(

)

const

Get all the objects in the file.

requiredObjects()

std::vector< IddObject > openstudio::IddFileAndFactoryWrapper::requiredObjects

(

)

const

Get all IddObjects in the file that are required.

An IdfFile (or Workspace) conforming to this IddFile must contain at least one object of each of these types.

setIddFile() [1/2]

void openstudio::IddFileAndFactoryWrapper::setIddFile

(

const IddFile &

iddFile

)

Set the IddFile explicitly.

This option does not use the IddFactory.

setIddFile() [2/2]

void openstudio::IddFileAndFactoryWrapper::setIddFile

(

IddFileType

iddFileType

)

Set the IddFile by specifying iddFileType.

This option uses the IddFactory, unless iddFileType == IddFileType::UserCustom, in which case a warning is logged.

uniqueObjects()

std::vector< IddObject > openstudio::IddFileAndFactoryWrapper::uniqueObjects

(

)

const

Get all IddObjects in the file that are marked as unique.

An IdfFile (or Workspace) conforming to this IddFile must contain at most one object of each of these types.

version()

std::string openstudio::IddFileAndFactoryWrapper::version

(

)

const

Get the file version.

versionObject()

boost::optional< IddObject > openstudio::IddFileAndFactoryWrapper::versionObject

(

)

const

If possible, returns the version IddObject for this IddFile.