Description

This class can be used to access files located on host, where winIDEA is running.

winIDEA instance is defined by connection manager provided in constructor.

This class is intended to be used when script is running on other host than the one running winIDEA.

Important: Complete file is copied to memory, so size of file to be read or written is limited by available computer memory.

Python example: test_exists.py

#include <CRemoteFileController.h>

Inheritance diagram for isys::CRemoteFileController:

Public Member Functions
bool	exists (const std::string &fileName)
	Returns true, if remote file (on host running winIDEA) exists.

void	readFromRemote (const std::string &remoteSrcFile, const std::string &localDestFile)
	Reads remote file and saves it locally.

bool	remove (const std::string &fileName)
	Deletes remote file (on host running winIDEA).

void	writeToRemote (const std::string &localSrcFile, const std::string &remoteDestFile)
	Writes local file to remote host.

Member Function Documentation

bool isys::CRemoteFileController::exists ( const std::string & fileName )

Returns true, if remote file (on host running winIDEA) exists.

Python example: test_exists.py

void isys::CRemoteFileController::readFromRemote	(	const std::string &	remoteSrcFile,
		const std::string &	localDestFile )

Reads remote file and saves it locally.

Parameters

localDestFile	local file used for saving. If the file exists, it is overwritten.
remoteSrcFile	remote file to be copied to local host.

bool isys::CRemoteFileController::remove ( const std::string & fileName )

Deletes remote file (on host running winIDEA).

Python example: test_remove.py

void isys::CRemoteFileController::writeToRemote	(	const std::string &	localSrcFile,
		const std::string &	remoteDestFile )

Writes local file to remote host.

Parameters

localSrcFile	local file used as source.
remoteDestFile	remote file used as destination. If the file exists, it is overwritten.