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

#include <UpdateManager.hpp>

Public Member Functions

std::string appName () const
 returns the application name More...
 
bool error () const
 returns true if an error occurred while checking for updates, must call after update manager is finished More...
 
bool finished () const
 returns true when the manager is finished checking for updates More...
 
std::string mostRecentDownloadUrl () const
 returns url for the most recent download, manager must have finished checking for updates with no errors More...
 
std::string mostRecentVersion () const
 returns most recent version, manager must have finished checking for updates with no errors More...
 
bool newMajorRelease () const
 returns true if a new major release is available, manager must have finished checking for updates with no errors More...
 
bool newMinorRelease () const
 returns true if a new minor release is available, manager must have finished checking for updates with no errors More...
 
bool newPatchRelease () const
 returns true if a new patch release is available, manager must have finished checking for updates with no errors More...
 
 UpdateManager (const std::string &appName)
 Constructor with application name. More...
 
 UpdateManager (const std::string &appName, const std::string &url)
 Constructor with application name and alternate test Url. More...
 
std::vector< std::string > updateMessages () const
 returns the description of each update since the current release with the most recent first, manager must have finished checking for updates with no errors More...
 
bool waitForFinished (int msec=120000) const
 
virtual ~UpdateManager ()
 

Detailed Description

Class for checking whether a new version of OpenStudio is available for download.

Constructor & Destructor Documentation

openstudio::UpdateManager::UpdateManager ( const std::string &  appName)

Constructor with application name.

openstudio::UpdateManager::UpdateManager ( const std::string &  appName,
const std::string &  url 
)

Constructor with application name and alternate test Url.

virtual openstudio::UpdateManager::~UpdateManager ( )
inlinevirtual

Member Function Documentation

std::string openstudio::UpdateManager::appName ( ) const

returns the application name

bool openstudio::UpdateManager::error ( ) const

returns true if an error occurred while checking for updates, must call after update manager is finished

bool openstudio::UpdateManager::finished ( ) const

returns true when the manager is finished checking for updates

std::string openstudio::UpdateManager::mostRecentDownloadUrl ( ) const

returns url for the most recent download, manager must have finished checking for updates with no errors

std::string openstudio::UpdateManager::mostRecentVersion ( ) const

returns most recent version, manager must have finished checking for updates with no errors

bool openstudio::UpdateManager::newMajorRelease ( ) const

returns true if a new major release is available, manager must have finished checking for updates with no errors

bool openstudio::UpdateManager::newMinorRelease ( ) const

returns true if a new minor release is available, manager must have finished checking for updates with no errors

bool openstudio::UpdateManager::newPatchRelease ( ) const

returns true if a new patch release is available, manager must have finished checking for updates with no errors

std::vector<std::string> openstudio::UpdateManager::updateMessages ( ) const

returns the description of each update since the current release with the most recent first, manager must have finished checking for updates with no errors

bool openstudio::UpdateManager::waitForFinished ( int  msec = 120000) const