OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::ExternalFile Class Reference

#include <ExternalFile.hpp>

+ Inheritance diagram for openstudio::model::ExternalFile:

Public Member Functions

Constructors and Destructors
virtual ~ExternalFile ()=default
 
 ExternalFile (const ExternalFile &other)=default
 
 ExternalFile (ExternalFile &&other)=default
 
ExternalFileoperator= (const ExternalFile &)=default
 
ExternalFileoperator= (ExternalFile &&)=default
 
Getters
std::string fileName () const
 
path filePath () const
 
Other
std::vector< ScheduleFilescheduleFiles () const
 
std::vector< PythonPluginInstancepythonPluginInstances () const
 
std::vector
< ChillerElectricASHRAE205
chillerElectricASHRAE205s () const
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static std::vector< std::string > columnSeparatorValues ()
 
static boost::optional
< ExternalFile
getExternalFile (const Model &model, const std::string &filename, bool copyFile=true)
 This factory method will look for an existing ExternalFile with the same file name. More...
 
static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

using ExternalFileVector = std::vector< ExternalFile >
 
using OptionalExternalFile = boost::optional< ExternalFile >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- 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)
 

Detailed Description

ExternalFile is a ResourceObject that wraps the OpenStudio IDD object 'OS:External:File'.

Constructor & Destructor Documentation

virtual openstudio::model::ExternalFile::~ExternalFile ( )
virtualdefault
openstudio::model::ExternalFile::ExternalFile ( const ExternalFile other)
default
openstudio::model::ExternalFile::ExternalFile ( ExternalFile &&  other)
default

Member Function Documentation

std::vector<ChillerElectricASHRAE205> openstudio::model::ExternalFile::chillerElectricASHRAE205s ( ) const
static std::vector<std::string> openstudio::model::ExternalFile::columnSeparatorValues ( )
static
std::string openstudio::model::ExternalFile::fileName ( ) const
path openstudio::model::ExternalFile::filePath ( ) const
static boost::optional<ExternalFile> openstudio::model::ExternalFile::getExternalFile ( const Model model,
const std::string &  filename,
bool  copyFile = true 
)
static

This factory method will look for an existing ExternalFile with the same file name.

If not it will try to create one.

  • If copyFile is true, the file will be copied to the first entry of the WorkflowJSON's absoluteFilePaths() (or absoluteRootDir() if empty);
  • If copyFile is false, it assumes this is an absolute path. In both cases, the filename should resolve to a valid path or this will return an empty optional.
static IddObjectType openstudio::model::ExternalFile::iddObjectType ( )
static
ExternalFile& openstudio::model::ExternalFile::operator= ( const ExternalFile )
default
ExternalFile& openstudio::model::ExternalFile::operator= ( ExternalFile &&  )
default
std::vector<PythonPluginInstance> openstudio::model::ExternalFile::pythonPluginInstances ( ) const
std::vector<ScheduleFile> openstudio::model::ExternalFile::scheduleFiles ( ) const

Friends And Related Function Documentation

using ExternalFileVector = std::vector<ExternalFile>
related
using OptionalExternalFile = boost::optional<ExternalFile>
related