openstudio::model::OutputControlFiles Class Reference

#include <OutputControlFiles.hpp>

Inheritance diagram for openstudio::model::OutputControlFiles:

Public Member Functions
Constructors and Destructors
virtual	~OutputControlFiles ()=default
	OutputControlFiles (const OutputControlFiles &other)=default
	OutputControlFiles (OutputControlFiles &&other)=default
OutputControlFiles &	operator= (const OutputControlFiles &)=default
OutputControlFiles &	operator= (OutputControlFiles &&)=default
Getters
bool	outputCSV () const
bool	outputMTR () const
bool	outputESO () const
bool	outputEIO () const
bool	outputTabular () const
bool	outputSQLite () const
bool	outputJSON () const
bool	outputAUDIT () const
bool	outputZoneSizing () const
bool	outputSystemSizing () const
bool	outputDXF () const
bool	outputBND () const
bool	outputRDD () const
bool	outputMDD () const
bool	outputMTD () const
bool	outputSHD () const
bool	outputDFS () const
bool	outputGLHE () const
bool	outputDelightIn () const
bool	outputDelightELdmp () const
bool	outputDelightDFdmp () const
bool	outputEDD () const
bool	outputDBG () const
bool	outputPerfLog () const
bool	outputSLN () const
bool	outputSCI () const
bool	outputWRL () const
bool	outputScreen () const
bool	outputExtShd () const
bool	outputTarcog () const
Setters
bool	setOutputCSV (bool outputCSV)
bool	setOutputMTR (bool outputMTR)
bool	setOutputESO (bool outputESO)
bool	setOutputEIO (bool outputEIO)
bool	setOutputTabular (bool outputTabular)
bool	setOutputSQLite (bool outputSQLite)
bool	setOutputJSON (bool outputJSON)
bool	setOutputAUDIT (bool outputAUDIT)
bool	setOutputZoneSizing (bool outputZoneSizing)
bool	setOutputSystemSizing (bool outputSystemSizing)
bool	setOutputDXF (bool outputDXF)
bool	setOutputBND (bool outputBND)
bool	setOutputRDD (bool outputRDD)
bool	setOutputMDD (bool outputMDD)
bool	setOutputMTD (bool outputMTD)
bool	setOutputSHD (bool outputSHD)
bool	setOutputDFS (bool outputDFS)
bool	setOutputGLHE (bool outputGLHE)
bool	setOutputDelightIn (bool outputDelightIn)
bool	setOutputDelightELdmp (bool outputDelightELdmp)
bool	setOutputDelightDFdmp (bool outputDelightDFdmp)
bool	setOutputEDD (bool outputEDD)
bool	setOutputDBG (bool outputDBG)
bool	setOutputPerfLog (bool outputPerfLog)
bool	setOutputSLN (bool outputSLN)
bool	setOutputSCI (bool outputSCI)
bool	setOutputWRL (bool outputWRL)
bool	setOutputScreen (bool outputScreen)
bool	setOutputExtShd (bool outputExtShd)
bool	setOutputTarcog (bool outputTarcog)
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model(). More...
ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model. More...
Component	createComponent () const
	Method for creating sharable Model snippets. More...
Model	model () const
	Returns the Model that contains this object. More...
boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject. More...
template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object. More...
template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object. More...
template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index. More...
template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points. More...
const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object. More...
std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data. More...
boost::optional < openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object. More...
std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object. More...
std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object. More...
IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with. More...
AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary. More...
bool	hasAdditionalProperties () const
	Returns true if this object has additional properties. More...
std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object. More...
boost::optional< std::string >	cadObjectId () const
bool	setCADObjectId (const std::string &cadObjectId)
boost::optional< std::string >	gbXMLId () const
bool	setGBXMLId (const std::string &gbXMLId)
boost::optional< std::string >	displayName () const
bool	setDisplayName (const std::string &displayName)
bool	setParent (ParentObject &newParent)
	set the parent, child may have to call non-const methods on the parent More...
bool	operator< (const ModelObject &right) const
bool	operator== (const ModelObject &other) const
	equality test More...
bool	operator!= (const ModelObject &other) const
	inequality test More...
std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file. More...
virtual std::vector < EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators. More...
virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables. More...
boost::optional< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const
Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const
bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
std::vector< std::string >	canBeTarget () const
boost::optional< std::string >	getField (unsigned index) const
std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const
std::vector< WorkspaceObject >	getSources (IddObjectType type) const
boost::optional< WorkspaceObject >	getTarget (unsigned index) const
IdfObject	idfObject ()
IdfObject	idfObject () const
bool	initialized () const
bool	isSource () const
bool	isTarget () const
unsigned	numSources () const
bool	objectListFieldsEqual (const WorkspaceObject &other) const
bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const
bool	operator< (const WorkspaceObject &right) const
std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
WorkspaceObject &	operator= (WorkspaceObject &&)=default
WorkspaceObject &	operator= (const WorkspaceObject &)=default
std::vector < openstudio::IdfObject >	remove ()
bool	setPointer (unsigned index, const Handle &targetHandle)
std::vector< WorkspaceObject >	sources () const
std::vector< WorkspaceObject >	targets () const
Workspace	workspace () const
	WorkspaceObject (WorkspaceObject &&other)=default
	WorkspaceObject (const WorkspaceObject &other)=default
virtual	~WorkspaceObject ()=default
Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const
T	cast () const
std::vector< T >	castVector (const std::vector< U > &objects)
std::vector< std::vector < std::string > >	clearExtensibleGroups ()
IdfObject	clone (bool keepHandle=false) const
std::string	comment () const
boost::optional< std::string >	createName (bool overwrite=true)
std::vector< unsigned >	dataFields () const
bool	dataFieldsEqual (const IdfObject &other) const
std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)
std::vector< IdfExtensibleGroup >	extensibleGroups () const
boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const
boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const
IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const
std::vector< Handle >	getHandles (const std::vector< T > &objects)
boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const
OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const
Handle	handle () const
IddObject	iddObject () const
	IdfObject (IddObjectType type, bool fastName=false)
	IdfObject (const IdfObject &other)
	IdfObject (const IddObject &, bool fastName=false)
	IdfObject (IdfObject &&other) noexcept
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
bool	isDataField (unsigned index) const
bool	isEmpty (unsigned index) const
bool	isObjectListField (unsigned index) const
bool	isValid (StrictnessLevel level, bool checkNames=false) const
boost::optional< unsigned >	maxExtensibleGroups () const
boost::optional< unsigned >	maxFields () const
unsigned	minExtensibleGroups () const
unsigned	minFields () const
boost::optional< std::string >	name (bool returnDefault=false) const
std::string	nameString (bool returnDefault=false) const
unsigned	numExtensibleGroups () const
unsigned	numFields () const
unsigned	numNonextensibleFields () const
std::vector< unsigned >	objectListFields () const
bool	objectListFieldsEqual (const IdfObject &other) const
bool	objectListFieldsNonConflicting (const IdfObject &other) const
bool	operator!= (const IdfObject &other) const
std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)
IdfObject &	operator= (IdfObject &&other) noexcept
IdfObject &	operator= (const IdfObject &other)
bool	operator== (const IdfObject &other) const
boost::optional< T >	optionalCast () const
std::vector< std::string >	popExtensibleGroup ()
std::ostream &	print (std::ostream &os) const
std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const
std::ostream &	printName (std::ostream &os, bool hasFields=true) const
IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)
IdfExtensibleGroup	pushExtensibleGroup ()
std::vector< unsigned >	requiredFields () const
void	setComment (const std::string &msg)
bool	setDouble (unsigned index, double value)
bool	setFieldComment (unsigned index, const std::string &cmnt)
bool	setInt (unsigned index, int value)
boost::optional< std::string >	setName (const std::string &newName)
bool	setQuantity (unsigned index, const Quantity &q)
bool	setString (unsigned index, const std::string &value)
bool	setUnsigned (unsigned index, unsigned value)
std::vector< T >	subsetCastVector (const std::vector< U > &original)
ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const
virtual	~IdfObject ()=default

Static Public Member Functions
static IddObjectType	iddObjectType ()
Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)
static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)
static int	printedFieldSpace ()

Related Functions
(Note that these are not member functions.)
using	OptionalOutputControlFiles = boost::optional< OutputControlFiles >
using	OutputControlFilesVector = std::vector< OutputControlFiles >
Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional < WorkspaceObject >	OptionalWorkspaceObject
typedef std::vector < WorkspaceObject >	WorkspaceObjectVector
Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair
typedef std::vector< IdfObject >	IdfObjectVector
typedef boost::optional < IdfObject >	OptionalIdfObject
Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl
Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType
Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType
Protected Member Functions inherited from openstudio::model::ModelObject
	ModelObject (IddObjectType type, const Model &model, bool fastName=false)
	ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)

Detailed Description

OutputControlFiles is a ModelObject that wraps the OpenStudio IDD object 'OS:OutputControl:Files'.

Constructor & Destructor Documentation

virtual openstudio::model::OutputControlFiles::~OutputControlFiles ( )

virtualdefault

openstudio::model::OutputControlFiles::OutputControlFiles ( const OutputControlFiles &  other )

default

openstudio::model::OutputControlFiles::OutputControlFiles ( OutputControlFiles &&  other )

default

Member Function Documentation

static IddObjectType openstudio::model::OutputControlFiles::iddObjectType ( )

static

OutputControlFiles& openstudio::model::OutputControlFiles::operator= ( const OutputControlFiles &  )

default

OutputControlFiles& openstudio::model::OutputControlFiles::operator= ( OutputControlFiles &&  )

default

bool openstudio::model::OutputControlFiles::outputAUDIT

(

)

const

bool openstudio::model::OutputControlFiles::outputBND

(

)

const

bool openstudio::model::OutputControlFiles::outputCSV

(

)

const

bool openstudio::model::OutputControlFiles::outputDBG

(

)

const

bool openstudio::model::OutputControlFiles::outputDelightDFdmp

(

)

const

bool openstudio::model::OutputControlFiles::outputDelightELdmp

(

)

const

bool openstudio::model::OutputControlFiles::outputDelightIn

(

)

const

bool openstudio::model::OutputControlFiles::outputDFS

(

)

const

bool openstudio::model::OutputControlFiles::outputDXF

(

)

const

bool openstudio::model::OutputControlFiles::outputEDD

(

)

const

bool openstudio::model::OutputControlFiles::outputEIO

(

)

const

bool openstudio::model::OutputControlFiles::outputESO

(

)

const

bool openstudio::model::OutputControlFiles::outputExtShd

(

)

const

bool openstudio::model::OutputControlFiles::outputGLHE

(

)

const

bool openstudio::model::OutputControlFiles::outputJSON

(

)

const

bool openstudio::model::OutputControlFiles::outputMDD

(

)

const

bool openstudio::model::OutputControlFiles::outputMTD

(

)

const

bool openstudio::model::OutputControlFiles::outputMTR

(

)

const

bool openstudio::model::OutputControlFiles::outputPerfLog

(

)

const

bool openstudio::model::OutputControlFiles::outputRDD

(

)

const

bool openstudio::model::OutputControlFiles::outputSCI

(

)

const

bool openstudio::model::OutputControlFiles::outputScreen

(

)

const

bool openstudio::model::OutputControlFiles::outputSHD

(

)

const

bool openstudio::model::OutputControlFiles::outputSLN

(

)

const

bool openstudio::model::OutputControlFiles::outputSQLite

(

)

const

bool openstudio::model::OutputControlFiles::outputSystemSizing

(

)

const

bool openstudio::model::OutputControlFiles::outputTabular

(

)

const

bool openstudio::model::OutputControlFiles::outputTarcog

(

)

const

bool openstudio::model::OutputControlFiles::outputWRL

(

)

const

bool openstudio::model::OutputControlFiles::outputZoneSizing

(

)

const

bool openstudio::model::OutputControlFiles::setOutputAUDIT

(

bool

outputAUDIT

)

bool openstudio::model::OutputControlFiles::setOutputBND

(

bool

outputBND

)

bool openstudio::model::OutputControlFiles::setOutputCSV

(

bool

outputCSV

)

bool openstudio::model::OutputControlFiles::setOutputDBG

(

bool

outputDBG

)

bool openstudio::model::OutputControlFiles::setOutputDelightDFdmp

(

bool

outputDelightDFdmp

)

bool openstudio::model::OutputControlFiles::setOutputDelightELdmp

(

bool

outputDelightELdmp

)

bool openstudio::model::OutputControlFiles::setOutputDelightIn

(

bool

outputDelightIn

)

bool openstudio::model::OutputControlFiles::setOutputDFS

(

bool

outputDFS

)

bool openstudio::model::OutputControlFiles::setOutputDXF

(

bool

outputDXF

)

bool openstudio::model::OutputControlFiles::setOutputEDD

(

bool

outputEDD

)

bool openstudio::model::OutputControlFiles::setOutputEIO

(

bool

outputEIO

)

bool openstudio::model::OutputControlFiles::setOutputESO

(

bool

outputESO

)

bool openstudio::model::OutputControlFiles::setOutputExtShd

(

bool

outputExtShd

)

bool openstudio::model::OutputControlFiles::setOutputGLHE

(

bool

outputGLHE

)

bool openstudio::model::OutputControlFiles::setOutputJSON

(

bool

outputJSON

)

bool openstudio::model::OutputControlFiles::setOutputMDD

(

bool

outputMDD

)

bool openstudio::model::OutputControlFiles::setOutputMTD

(

bool

outputMTD

)

bool openstudio::model::OutputControlFiles::setOutputMTR

(

bool

outputMTR

)

bool openstudio::model::OutputControlFiles::setOutputPerfLog

(

bool

outputPerfLog

)

bool openstudio::model::OutputControlFiles::setOutputRDD

(

bool

outputRDD

)

bool openstudio::model::OutputControlFiles::setOutputSCI

(

bool

outputSCI

)

bool openstudio::model::OutputControlFiles::setOutputScreen

(

bool

outputScreen

)

bool openstudio::model::OutputControlFiles::setOutputSHD

(

bool

outputSHD

)

bool openstudio::model::OutputControlFiles::setOutputSLN

(

bool

outputSLN

)

bool openstudio::model::OutputControlFiles::setOutputSQLite

(

bool

outputSQLite

)

bool openstudio::model::OutputControlFiles::setOutputSystemSizing

(

bool

outputSystemSizing

)

bool openstudio::model::OutputControlFiles::setOutputTabular

(

bool

outputTabular

)

bool openstudio::model::OutputControlFiles::setOutputTarcog

(

bool

outputTarcog

)

bool openstudio::model::OutputControlFiles::setOutputWRL

(

bool

outputWRL

)

bool openstudio::model::OutputControlFiles::setOutputZoneSizing

(

bool

outputZoneSizing

)

Friends And Related Function Documentation

using OptionalOutputControlFiles = boost::optional<OutputControlFiles>

related

using OutputControlFilesVector = std::vector<OutputControlFiles>

related