OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
openstudio::URLSearchPath Class Reference

#include <URLSearchPath.hpp>

Public Types

enum  Relative { ToInputFile, ToCurrentWorkingDir }
 

Public Member Functions

boost::optional< IddObjectTypegetIddObjectType () const
 
Relative getRelativity () const
 
QUrl getUrl () const
 
 URLSearchPath (const QUrl &t_url, Relative t_relativity=ToInputFile)
 Create a new URLSearchPath. More...
 
 URLSearchPath (const QUrl &t_url, Relative t_relativity, IddObjectType t_object_type)
 Create a new URLSearchPath. More...
 
 URLSearchPath (const openstudio::path &t_path, Relative t_relativity=ToInputFile)
 Create a new URLSearchPath. More...
 
 URLSearchPath (const openstudio::path &t_path, Relative t_relativity, IddObjectType t_object_type)
 Create a new URLSearchPath. More...
 

Member Enumeration Documentation

Enumerator
ToInputFile 
ToCurrentWorkingDir 

Constructor & Destructor Documentation

openstudio::URLSearchPath::URLSearchPath ( const QUrl &  t_url,
Relative  t_relativity = ToInputFile 
)
inline

Create a new URLSearchPath.

Parameters
[in]t_urlUrl to search (local or remote, remote not yet implemented)
[in]t_relativityIf t_url is a relative path, it is evaluated relative to t_relativity.
openstudio::URLSearchPath::URLSearchPath ( const QUrl &  t_url,
Relative  t_relativity,
IddObjectType  t_object_type 
)
inline

Create a new URLSearchPath.

Parameters
[in]t_urlUrl to search (local or remote, remote not yet implemented)
[in]t_relativityIf t_url is a relative path, it is evaluated relative to t_relativity.
[in]t_object_typeObject type to apply this search to
openstudio::URLSearchPath::URLSearchPath ( const openstudio::path &  t_path,
Relative  t_relativity = ToInputFile 
)
inline

Create a new URLSearchPath.

Parameters
[in]t_pathlocal path to search
[in]t_relativityIf t_url is a relative path, it is evaluated relative to t_relativity.
openstudio::URLSearchPath::URLSearchPath ( const openstudio::path &  t_path,
Relative  t_relativity,
IddObjectType  t_object_type 
)
inline

Create a new URLSearchPath.

Parameters
[in]t_pathlocal path to search
[in]t_relativityIf t_url is a relative path, it is evaluated relative to t_relativity.
[in]t_object_typeObject type to apply this search to

Member Function Documentation

boost::optional<IddObjectType> openstudio::URLSearchPath::getIddObjectType ( ) const
inline
Relative openstudio::URLSearchPath::getRelativity ( ) const
inline
QUrl openstudio::URLSearchPath::getUrl ( ) const
inline