openstudio::AWSSettings Class Reference

#include <AWSProvider.hpp>

Inheritance diagram for openstudio::AWSSettings:

Public Member Functions
Constructor
	AWSSettings ()
	default constructor, loads defaults from settings More...
	AWSSettings (const UUID &uuid, const UUID &versionUUID, bool userAgreementSigned, unsigned numWorkers, bool terminationDelayEnabled, unsigned terminationDelay, std::string region, std::string serverInstanceType, std::string workerInstanceType)
	Constructor provided for deserialization; not for general use. More...
Destructors
virtual	~AWSSettings ()
	virtual destructor More...
Class members
std::string	accessKey () const
bool	setAccessKey (const std::string &accessKey)
std::string	secretKey () const
bool	setSecretKey (const std::string &secretKey)
bool	validAccessKey (const std::string &accessKey) const
bool	validAccessKey () const
bool	validSecretKey (const std::string &secretKey) const
bool	validSecretKey () const
void	clearKeys ()
unsigned	numWorkers () const
unsigned	setNumWorkers (const unsigned numWorkers)
bool	terminationDelayEnabled () const
void	setTerminationDelayEnabled (bool enabled)
unsigned	terminationDelay () const
void	setTerminationDelay (const unsigned delay)
std::string	region () const
void	setRegion (const std::string &region)
std::string	serverInstanceType () const
void	setServerInstanceType (const std::string &instanceType)
std::string	workerInstanceType () const
void	setWorkerInstanceType (const std::string &instanceType)
Public Member Functions inherited from openstudio::CloudSettings
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 ()
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::AWSSettings_Impl	ImplType
Protected Types inherited from openstudio::CloudSettings
typedef detail::CloudSettings_Impl	ImplType

Protected Member Functions
	AWSSettings (const std::shared_ptr< detail::AWSSettings_Impl > &impl)
Protected Member Functions inherited from openstudio::CloudSettings
	CloudSettings (const std::shared_ptr< detail::CloudSettings_Impl > &impl)

Related Functions
(Note that these are not member functions.)
typedef boost::optional < AWSSettings >	OptionalAWSSettings

Detailed Description

AWSSettings is a CloudSettings.

Member Typedef Documentation

typedef detail::AWSSettings_Impl openstudio::AWSSettings::ImplType

protected

Constructor & Destructor Documentation

openstudio::AWSSettings::AWSSettings

(

)

default constructor, loads defaults from settings

openstudio::AWSSettings::AWSSettings	(	const UUID &	uuid,
		const UUID &	versionUUID,
		bool	userAgreementSigned,
		unsigned	numWorkers,
		bool	terminationDelayEnabled,
		unsigned	terminationDelay,
		std::string	region,
		std::string	serverInstanceType,
		std::string	workerInstanceType
	)

Constructor provided for deserialization; not for general use.

virtual openstudio::AWSSettings::~AWSSettings ( )

inlinevirtual

virtual destructor

openstudio::AWSSettings::AWSSettings ( const std::shared_ptr< detail::AWSSettings_Impl > &  impl )

protected

Member Function Documentation

std::string openstudio::AWSSettings::accessKey

(

)

const

void openstudio::AWSSettings::clearKeys

(

)

unsigned openstudio::AWSSettings::numWorkers

(

)

const

std::string openstudio::AWSSettings::region

(

)

const

std::string openstudio::AWSSettings::secretKey

(

)

const

std::string openstudio::AWSSettings::serverInstanceType

(

)

const

bool openstudio::AWSSettings::setAccessKey

(

const std::string &

accessKey

)

unsigned openstudio::AWSSettings::setNumWorkers

(

const unsigned

numWorkers

)

void openstudio::AWSSettings::setRegion

(

const std::string &

region

)

bool openstudio::AWSSettings::setSecretKey

(

const std::string &

secretKey

)

void openstudio::AWSSettings::setServerInstanceType

(

const std::string &

instanceType

)

void openstudio::AWSSettings::setTerminationDelay

(

const unsigned

delay

)

void openstudio::AWSSettings::setTerminationDelayEnabled

(

bool

enabled

)

void openstudio::AWSSettings::setWorkerInstanceType

(

const std::string &

instanceType

)

unsigned openstudio::AWSSettings::terminationDelay

(

)

const

bool openstudio::AWSSettings::terminationDelayEnabled

(

)

const

bool openstudio::AWSSettings::validAccessKey

(

const std::string &

accessKey

)

const

bool openstudio::AWSSettings::validAccessKey

(

)

const

bool openstudio::AWSSettings::validSecretKey

(

const std::string &

secretKey

)

const

bool openstudio::AWSSettings::validSecretKey

(

)

const

std::string openstudio::AWSSettings::workerInstanceType

(

)

const

Friends And Related Function Documentation

typedef boost::optional<AWSSettings> OptionalAWSSettings

related