openstudio::CloudSettings Class Reference

#include <CloudProvider.hpp>

Inheritance diagram for openstudio::CloudSettings:

Public Member Functions
std::string	cloudProviderType () const
bool	loadSettings (bool overwriteExisting=false)
bool	saveToSettings (bool overwriteExisting=false) const
void	signUserAgreement (bool agree)
	signs the user agreement if passed in true, unsigns if passed in false More...
bool	userAgreementSigned () const
	returns true if the user has signed the user agreement More...
std::string	userAgreementText () const
	returns the user agreement text More...
UUID	uuid () const
	Unique identifier for OSP. More...
UUID	versionUUID () const
	Unique identifier of version for OSP. More...
virtual	~CloudSettings ()
Type Casting
template<typename T >
T	cast () const
	cast to type T, can throw std::bad_cast More...
template<typename T >
boost::optional< T >	optionalCast () const
	cast to optional of type T More...

Protected Types
typedef detail::CloudSettings_Impl	ImplType

Protected Member Functions
	CloudSettings (const std::shared_ptr< detail::CloudSettings_Impl > &impl)

Detailed Description

CloudSettings returns the information needed to use a CloudProvider (e.g. username, password, etc)

Member Typedef Documentation

typedef detail::CloudSettings_Impl openstudio::CloudSettings::ImplType

protected

Constructor & Destructor Documentation

virtual openstudio::CloudSettings::~CloudSettings ( )

virtual

openstudio::CloudSettings::CloudSettings ( const std::shared_ptr< detail::CloudSettings_Impl > &  impl )

protected

Member Function Documentation

template<typename T >

T openstudio::CloudSettings::cast ( ) const

inline

cast to type T, can throw std::bad_cast

std::string openstudio::CloudSettings::cloudProviderType

(

)

const

bool openstudio::CloudSettings::loadSettings

(

bool

overwriteExisting = false

)

template<typename T >

boost::optional<T> openstudio::CloudSettings::optionalCast ( ) const

inline

cast to optional of type T

bool openstudio::CloudSettings::saveToSettings

(

bool

overwriteExisting = false

)

const

void openstudio::CloudSettings::signUserAgreement

(

bool

agree

)

signs the user agreement if passed in true, unsigns if passed in false

bool openstudio::CloudSettings::userAgreementSigned

(

)

const

returns true if the user has signed the user agreement

std::string openstudio::CloudSettings::userAgreementText

(

)

const

returns the user agreement text

UUID openstudio::CloudSettings::uuid

(

)

const

Unique identifier for OSP.

UUID openstudio::CloudSettings::versionUUID

(

)

const

Unique identifier of version for OSP.

(To avoid unnecessary overhead when nothing has changed.)