openstudio::bimserver::BIMserverConnection Class Reference

#include <BIMserverConnection.hpp>

Inheritance diagram for openstudio::bimserver::BIMserverConnection:

Public Member Functions
	BIMserverConnection (QObject *parent, QString bimserverAddr, QString bimserverPort)
	Default constructor. More...
	~BIMserverConnection ()
	destructor More...
Unblocking class members
void	login (QString username, QString password)
	login with username and password More...
void	download (QString projectID)
	download the osm model More...
void	getAllProjects ()
	get all projects More...
void	createProject (QString projectName)
	create new project More...
void	deleteProject (QString projectID)
	delete a project More...
void	checkInIFCFile (QString projectID, QString IFCFilePath)
	check in new ifc file More...
void	getIFCRevisionList (QString projectID)
	get all revisions of IFC files of a project More...

Blocking class members
bool	loginBlocked (QString username, QString password, int timeout)
	Login, Blocked. More...
boost::optional< QString >	downloadBlocked (QString projectID, int timeout)
	download the osm model, Blocked More...
boost::optional< QStringList >	getAllProjectsBlocked (int timeout)
	get all projects, Blocked More...
bool	createProjectBlocked (QString projectName, int timeout)
	create new project, Blocked More...
bool	deleteProjectBlocked (QString projectID, int timeout)
	delete a project, Blocked More...
bool	checkInIFCFileBlocked (QString projectID, QString IFCFilePath, int timeout)
	check in new ifc file, Blocked More...
boost::optional< QStringList >	getIFCRevisionListBlocked (QString projectID, int timeout)
	get all revisions of IFC files of a project, Blocked More...
void	osmStringRetrieved (QString osmString)
	send the retrieved osmString to GUI More...
void	listAllProjects (QStringList projectList)
	send the list of all projects to GUI More...
void	listAllIFCRevisions (QStringList ifcRevisionList)
	send the list of all ifc revisions More...
void	errorOccured (QString errorMessage)
	emit error occurs signal More...
void	operationSucceeded (QString successMessage)
	operationSucceeded() will send one of the following QString: More...
void	bimserverError ()
	emit error if BIMserver is not setup correctly. More...

Detailed Description

This provides utilities to connect to BIMserver.

Constructor & Destructor Documentation

openstudio::bimserver::BIMserverConnection::BIMserverConnection	(	QObject *	parent,
		QString	bimserverAddr,
		QString	bimserverPort
	)

Default constructor.

openstudio::bimserver::BIMserverConnection::~BIMserverConnection

(

)

destructor

Member Function Documentation

void openstudio::bimserver::BIMserverConnection::bimserverError ( )

signal

emit error if BIMserver is not setup correctly.

void openstudio::bimserver::BIMserverConnection::checkInIFCFile	(	QString	projectID,
		QString	IFCFilePath
	)

check in new ifc file

bool openstudio::bimserver::BIMserverConnection::checkInIFCFileBlocked	(	QString	projectID,
		QString	IFCFilePath,
		int	timeout
	)

check in new ifc file, Blocked

void openstudio::bimserver::BIMserverConnection::createProject

(

QString

projectName

)

create new project

bool openstudio::bimserver::BIMserverConnection::createProjectBlocked	(	QString	projectName,
		int	timeout
	)

create new project, Blocked

void openstudio::bimserver::BIMserverConnection::deleteProject

(

QString

projectID

)

delete a project

bool openstudio::bimserver::BIMserverConnection::deleteProjectBlocked	(	QString	projectID,
		int	timeout
	)

delete a project, Blocked

void openstudio::bimserver::BIMserverConnection::download

(

QString

projectID

)

download the osm model

boost::optional<QString> openstudio::bimserver::BIMserverConnection::downloadBlocked	(	QString	projectID,
		int	timeout
	)

download the osm model, Blocked

void openstudio::bimserver::BIMserverConnection::errorOccured ( QString  errorMessage )

signal

emit error occurs signal

void openstudio::bimserver::BIMserverConnection::getAllProjects

(

)

get all projects

boost::optional<QStringList> openstudio::bimserver::BIMserverConnection::getAllProjectsBlocked

(

int

timeout

)

get all projects, Blocked

void openstudio::bimserver::BIMserverConnection::getIFCRevisionList

(

QString

projectID

)

get all revisions of IFC files of a project

boost::optional<QStringList> openstudio::bimserver::BIMserverConnection::getIFCRevisionListBlocked	(	QString	projectID,
		int	timeout
	)

get all revisions of IFC files of a project, Blocked

void openstudio::bimserver::BIMserverConnection::listAllIFCRevisions ( QStringList  ifcRevisionList )

signal

send the list of all ifc revisions

void openstudio::bimserver::BIMserverConnection::listAllProjects ( QStringList  projectList )

signal

send the list of all projects to GUI

void openstudio::bimserver::BIMserverConnection::login	(	QString	username,
		QString	password
	)

login with username and password

bool openstudio::bimserver::BIMserverConnection::loginBlocked	(	QString	username,
		QString	password,
		int	timeout
	)

Login, Blocked.

void openstudio::bimserver::BIMserverConnection::operationSucceeded ( QString  successMessage )

signal

operationSucceeded() will send one of the following QString:

void openstudio::bimserver::BIMserverConnection::osmStringRetrieved ( QString  osmString )

signal

send the retrieved osmString to GUI