Inheritance diagram for QRODS:

Public Slots
void	getPageData (FileListingEntry *, int firstIndex, int endIndex)
	QRODS::getPageData Gets page data. More...

void	valueChanged (int)
	QRODS::valueChanged Loads more pages. More...

void	expanded (const QModelIndex &)
	QRODS::expanded Expands the QRODS data. More...

void	collapsed (const QModelIndex &index)
	QRODS::collapsed Collapses the QModelIndex. More...

void	modelChanged ()
	QRODS::modelChanged resets the QRODS model. More...

Signals
void	notifyModelUpdated ()

Public Member Functions
	QRODS (QObject *parent=0)
	QRODS::QRODS Constructor. More...

	QRODS (QObject *parent, QString &host, int port, QString &user, QString &password)
	QRODS::QRODS Constructor. More...

void	setUser (QString &user)
	QRODS::setUser sets the user. More...

void	setPassword (QString &password)
	QRODS::setPassword sets the password. More...

void	setHost (QString &string)
	QRODS::setHost sets the host. More...

void	setPort (int port)
	QRODS::setPort sets the Port. More...

QString &	getQRODSVersion ()
	QRODS::getQRODSVersion gets QRODS version. More...

QString &	user ()
	QRODS::user gets user. More...

QString &	password ()
	QRODS::password returns the password. More...

QString &	host ()
	QRODS::host returns the host. More...

int	port ()
	QRODS::port gets the port. More...

QMetadataModel *	getDataModel ()
	QRODS::getDataModel returns a QRODS. More...

void	addCollection (QString &path)
	QRODS::addCollection adds a collection. More...

void	removeCollection (QString &path)
	QRODS::removeCollection removes a collection. More...

void	uploadFile (QString &remotePath, QString &localPath)
	QRODS::uploadFile uploads a file. More...

void	getFile (QString &remotePath, QString &localPath)
	QRODS::getFile get a file. More...

QList< MetadataEntry * > *	getDataObjectMetadata (QString &path)
	QRODS::getDataObjectMetadata gets the object data of a metadata. More...

void	removeDataObject (QString &path, bool force=false)
	QRODS::removeDataObject. More...

void	setDataPath (QString &dataObj)
	QRODS::setDataPath Sets the path of a remote object associated with the QRODS metadata model. More...

void	addCollectionMetadata (QString &path, MetadataEntry &)
	QRODS::addCollectionMetadata adds a collection to a metadata. More...

void	deleteCollectionMetadata (QString &path, MetadataEntry &)
	QRODS::deleteCollectionMetadata. More...

virtual bool	connectToServer ()
	QRODS::connectToServer connects to the server adopting the default zone /tempZone/home/rods. More...

virtual bool	connectToServer (QString path)
	QRODS::connectToServer connets to a server. More...

virtual bool	connectToServer (QString path, bool secureHttp)
	QRODS::connectToServer connects to server. More...

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const
	QRODS::index returns an index. More...

QModelIndex	parent (const QModelIndex &index) const
	QRODS::parent returns a QModelIndex. More...

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
	QRODS::data Returns QRODS data as a QVariant. More...

int	rowCount (const QModelIndex &parent=QModelIndex()) const
	QRODS::rowCount Returns the number of rows. More...

int	columnCount (const QModelIndex &parent=QModelIndex()) const
	QRODS::columnCount Returns the number of columns. More...

QVariant	headerData (int section, Qt::Orientation orientation, int role) const
	QRODS::headerData Returns the QRODS header data. More...

bool	hasChildren (const QModelIndex &parent=QModelIndex()) const
	QRODS::hasChildren checks if the QModelIndex has children. More...

void	setRootPath (const QString path)
	QRODS::setRootPath Sets the root path. More...

void	addView (QAbstractItemView *view)
	QRODS::addView Adds a view. More...

void	setVisibleColumns (QList< FileListingEntry::EntryColumn > &columns)
	QRODS::setVisibleColumns. More...

Protected Member Functions
FileListingEntry *	nodeFromIndex (const QModelIndex &index) const
	QRODS::nodeFromIndex Returns a FileListingEntry node. More...

void	loadMorePages (FileListingEntry *entry)
	QRODS::loadMorePages Loads pages. More...

Constructor & Destructor Documentation

QRODS::QRODS ( QObject * parent = 0 )

explicit

QRODS::QRODS Constructor.

This is a constructor for QRODS class.

Parameters

parent the parent Qt widget.

QRODS::QRODS	(	QObject *	parent,
		QString &	host,
		int	port,
		QString &	user,
		QString &	password
	)

explicit

QRODS::QRODS Constructor.

This is a constructor for QRODS class.

Parameters

parent	the parent Qt widget.
host	that has the Rest API system running.
port	adopted to communicate with the iRODS.
user	present on the iRODS system.
password	for connection to that user in the iRODS system.

Member Function Documentation

void QRODS::addCollection ( QString & path )

QRODS::addCollection adds a collection.

This method adds a collection according to the path received as parameter.

Parameters

path	a string parameter that represents the path where the collection will be created.

void QRODS::addCollectionMetadata	(	QString &	path,
		MetadataEntry &	entry
	)

QRODS::addCollectionMetadata adds a collection to a metadata.

This method adds a metadata entry to a remote object specified in path.

Parameters

path	a string that represents the path of the collection to be added.
map	represents the metadata entry.

void QRODS::addView ( QAbstractItemView * view )

QRODS::addView Adds a view.

This method associates a QAbstractItemView to QRODS. This association permits the QRODS control the view in case of model updates.

Parameters

view	a QAbstractItemView.

void QRODS::collapsed ( const QModelIndex & index )

slot

QRODS::collapsed Collapses the QModelIndex.

Collapses the QModelIndex passed as parameter.

Parameters

index a QModelIndex.

int QRODS::columnCount ( const QModelIndex & parent = QModelIndex() ) const

QRODS::columnCount Returns the number of columns.

Returns the number of columns of the view.

Parameters

parent the parent.

Returns: returns the number of columns for the table view.

bool QRODS::connectToServer ( )

virtual

QRODS::connectToServer connects to the server adopting the default zone /tempZone/home/rods.

Connects to the server dopting the default zone /tempZone/home/rods..

bool QRODS::connectToServer ( QString path )

virtual

QRODS::connectToServer connets to a server.

This method connects to the server in the iRODS zone specified by parameter.

Parameters

path	a string that represents the iRODS zone.

bool QRODS::connectToServer	(	QString	path,
		bool	secureHttp
	)

virtual

QRODS::connectToServer connects to server.

This method connects to the server in the iRODS zone specified by parameter. The other parameter specifies if https will be adopted or not.

Parameters

path	a string that represents the server to be connected.
secureHttp	a boolean that specify if HTTPS must be considered or not.

QVariant QRODS::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

QRODS::data Returns QRODS data as a QVariant.

Returns the data representation to be displayed in the model View according to the role passed as parameter.

Parameters

index	a QModelIndex.
role	an integer that represents a role.

Returns: returns QRODS data as a QVariant.

void QRODS::deleteCollectionMetadata	(	QString &	path,
		MetadataEntry &	entry
	)

QRODS::deleteCollectionMetadata.

This method deletes a metada entry from a remote object specified in path.

Parameters

path
entry

void QRODS::expanded ( const QModelIndex & index )

slot

QRODS::expanded Expands the QRODS data.

Expands the FileListingEntry according to the QModelIndex passed by parameter.

Parameters

index a QModelIndex.

QMetadataModel * QRODS::getDataModel ( )

QRODS::getDataModel returns a QRODS.

This method returns a QRODS metadata model.

Returns: a QRODS data model.

QList< MetadataEntry * > * QRODS::getDataObjectMetadata ( QString & path )

QRODS::getDataObjectMetadata gets the object data of a metadata.

This method gets a list of metadata related to a specified remote object.

Parameters

path	a string that represents the object path.

Returns: a list of object data of the metadata entry specfied as parameter.

void QRODS::getFile	(	QString &	remotePath,
		QString &	localPath
	)

QRODS::getFile get a file.

This method download a file located in remotePath to the localPath

Parameters

remotePath	a string that represents the path on the iRODS system.
localPath	a string that represents the local path.

void QRODS::getPageData	(	FileListingEntry *	entry,
		int	firstIndex,
		int	endIndex
	)

slot

QRODS::getPageData Gets page data.

Slot to be fired when the iRODS rest responds to a collection listing. It is responsible for notifying the QRODS that the model should be updated.

Parameters

entry	a FileListingEntry.
firstIndex	an integer that is the first index.
endIndex	an integer that is the last index.

QString & QRODS::getQRODSVersion ( )

QRODS::getQRODSVersion gets QRODS version.

Returns the QRODS Version.

Returns: the QRODS version.

bool QRODS::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

QRODS::hasChildren checks if the QModelIndex has children.

Returns TRUE if the QModelIndex passed as parameter has children.

Parameters

parent a QModelIndex.

Returns: returns TRUE if the QModelIndex passed as parameter has children.

QVariant QRODS::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role
	)		const

QRODS::headerData Returns the QRODS header data.

Returns the QRODS header data associated with a view column.

Parameters

section	an integer that is the section.
orientation	the vertical and horizontal orientation.
role	an integer that represents the role.

Returns: returns the QRODS header data as a QVariant.

QString & QRODS::host ( )

QRODS::host returns the host.

Returns the host.

Returns: the host.

QModelIndex QRODS::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

QRODS::index returns an index.

Returns a QModelIndex according to the parent passed by parameter.

Parameters

row	row.
column	column.
parent	parent.

Returns: returns a QModelIndex.

void QRODS::loadMorePages ( FileListingEntry * entry )

protected

QRODS::loadMorePages Loads pages.

Loads pages according to the FileListingEntry passed as parameter.

Parameters

entry a FileListingEntry.

void QRODS::modelChanged ( )

slot

QRODS::modelChanged resets the QRODS model.

Slot that reload the model in case of model changes. For instance, object delete or upload.

FileListingEntry * QRODS::nodeFromIndex ( const QModelIndex & index ) const

protected

QRODS::nodeFromIndex Returns a FileListingEntry node.

Returns a FileListingEntry node according to the QModelIndex passed as parameter.

Parameters

index the QModelIndex.

Returns: returns a FileListingEntry node according to the QModelIndex passed as parameter.

QModelIndex QRODS::parent ( const QModelIndex & child ) const

QRODS::parent returns a QModelIndex.

Returns a QModelIndex parent according to the child passed as parameter.

Parameters

child a QModelIndex.

Returns: returns a QModelIndex.

QString & QRODS::password ( )

QRODS::password returns the password.

Returns the password.

Returns: the password.

int QRODS::port ( )

QRODS::port gets the port.

Returns the port.

Returns: the port

void QRODS::removeCollection ( QString & path )

QRODS::removeCollection removes a collection.

This method removes the collection passed as parameter.

Parameters

path	a string that represents the path of the collection to be removed.

void QRODS::removeDataObject	(	QString &	path,
		bool	force = `false`
	)

QRODS::removeDataObject.

This method removes a data object specified as parameter.

Parameters

path	a string that represents the object to be removed.
force	a boolean to force the remove operation.

int QRODS::rowCount ( const QModelIndex & parent = QModelIndex() ) const

QRODS::rowCount Returns the number of rows.

Returns the number of rows related to the view.

Parameters

parent the parent.

Returns: returns the number of rows as an integer.

void QRODS::setDataPath ( QString & dataObj )

QRODS::setDataPath Sets the path of a remote object associated with the QRODS metadata model.

Sets the path of a remote object associated with the QRODS metadata model.

Parameters

dataObj a data object.

void QRODS::setHost ( QString & host )

QRODS::setHost sets the host.

Sets the IRODS host.

Parameters

host	a string that represents the host.

void QRODS::setPassword ( QString & password )

QRODS::setPassword sets the password.

Sets the IRODS password associated with the user.

Parameters

password a string that represents the password.

void QRODS::setPort ( int port )

QRODS::setPort sets the Port.

Sets the Port.

Parameters

port	an integer that represents the port to be used for communication with iRODS system.

void QRODS::setRootPath ( const QString path )

QRODS::setRootPath Sets the root path.

Sets the root path related to QRODS instance. For instance, if the root path is /tempZone/home/rods, QRODS instance will be able to manage objects/collections/metadata that are contained in this path.

Parameters

path	a string that represents the QRODS server path.

void QRODS::setUser ( QString & user )

QRODS::setUser sets the user.

Sets the IRODS user.

Parameters

user	a string that represents the user.

void QRODS::setVisibleColumns ( QList< FileListingEntry::EntryColumn > & columns )

QRODS::setVisibleColumns.

Parameters

columns

void QRODS::uploadFile	(	QString &	remotePath,
		QString &	localPath
	)

QRODS::uploadFile uploads a file.

This method uploads a file from the local path to the remote path specified as parameters.

Parameters

remotePath	a string that represents the path on the iRODS system.
localPath	a string that represents the source path.

QString & QRODS::user ( )

QRODS::user gets user.

Returns the iRODS user.

Returns: the iRODS user.

void QRODS::valueChanged ( int val )

slot

QRODS::valueChanged Loads more pages.

Loads more pages considering the value index passed as parameter.

Parameters

val	an integer that represents the index value.

The documentation for this class was generated from the following files:

qrods.h
qrods.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation