openstudio Namespace Reference

All OpenStudio code is placed in the openstudio namespace. More...

Namespaces
	commentRegex
	iddRegex

Classes
class	ExtensibleIndex
	Index pair for IdfObject fields in extensible groups. More...
class	IddField
	IddField represents a field in an IddObject, that is, the schema for a single piece of data (alpha or numeric) in an IDF. More...
struct	IddFieldProperties
	IddFieldProperties describes the properties of an IddField object, as specified by IDD markup. More...
class	IddFieldType
	Enumeration of IDF field types as defined by the possible values for the IDD \type flag. More...
class	IddFile
	IddFile provides parsing and printing of text files in Input Data Definition (IDD) format. More...
class	IddFileAndFactoryWrapper
	Wraps the functionality of IddFile and IddFactory into one class for use by IdfFile and Workspace. More...
class	IddKey
	IddKey represents an enumeration value for an IDD field of type choice. More...
struct	IddKeyProperties
	IddKeyProperties is an all public class describing the properties of an IddKey object. More...
class	IddObject
	IddObject represents an object in the Idd. More...
struct	IddObjectProperties
	IddObjectProperties describes the properties of an IddObject, as specified by object-level IDD markup. More...

Typedefs
typedef boost::optional < IddFieldType >	OptionalIddFieldType

Functions
IddFile	get_1_9_0_CBECC_IddFile ()
std::vector< std::string >	intersectReferenceLists (const std::vector< std::string > &list1, const std::vector< std::string > &list2)
	Returns the intersection of list1 and list2, as determined by IStringSet. More...
std::string	makeComment (const std::string &str)
	Appends '! ' to each line of str, if necessary. More...
std::string	makeIdfEditorComment (const std::string &str)
	Appends '!- ' to each line of str, if necessary. More...
std::ostream &	operator<< (std::ostream &os, const IddFieldType &e)

Detailed Description

All OpenStudio code is placed in the openstudio namespace.

OpenStudio utilities are placed directly in the openstudio namespace; higher level sub-projects are placed in sub-namespaces (e.g. openstudio::model).

Typedef Documentation

typedef boost::optional< IddFieldType > openstudio::OptionalIddFieldType

Function Documentation

IddFile openstudio::get_1_9_0_CBECC_IddFile

(

)

std::vector<std::string> openstudio::intersectReferenceLists	(	const std::vector< std::string > &	list1,
		const std::vector< std::string > &	list2
	)

Returns the intersection of list1 and list2, as determined by IStringSet.

std::string openstudio::makeComment

(

const std::string &

str

)

Appends '! ' to each line of str, if necessary.

No changes are made if each line with text is already prefixed with a '!'. If modifications are necessary,

• blank lines before and after all text blocks are retained as blank lines
• blank lines that fall between two text blocks are prefixed with '!' so that the returned string contains at most one comment block
• we boost::trim_left lines of text when that operation does not change the length of the string by more than one character; otherwise, we preserve the original indentation

std::string openstudio::makeIdfEditorComment

(

const std::string &

str

)

Appends '!- ' to each line of str, if necessary.

No changes are made if each line with text is already prefixed with a '!'. If modifications are necessary,

• blank lines before and after all text blocks are retained as blank lines
• blank lines that fall between two text blocks are prefixed with '!' so that the returned string contains at most one comment block
• we boost::trim_left lines of text when that operation does not change the length of the string by more than one character; otherwise, we preserve the original indentation

std::ostream& openstudio::operator<< ( std::ostream &  os, const IddFieldType &  e  )

inline