Elements 6.3.3
A C++ base framework for the Euclid Software.
Loading...
Searching...
No Matches
ElementsServices: Services for Python and C++

Services for runtime and tests. More...

Collaboration diagram for ElementsServices: Services for Python and C++:

Namespaces

namespace  Elements

Classes

class  Elements::Services::DataSync::DataSync
 A class to download test data from a data repository prior to the unit test run. More...
class  Elements::Services::DataSync::UnknownHost
 Exception raised when a hosting solution is not supported by the tool. More...
class  Elements::Services::DataSync::ConnectionConfiguration
 The connection configuration mainly holds: More...
class  Elements::Services::DataSync::DownloadFailed
 An exception raised when downloading fails. More...
class  Elements::Services::DataSync::DataSynchronizer
 Base class to synchronize test data. More...
class  Elements::Services::DataSync::DependencyConfiguration
 The dependency configurations holds, for each test file to be retrieved: More...
class  Elements::Services::DataSync::IrodsSynchronizer
 A data synchronizer for iRODS hosts. More...
class  Elements::Services::DataSync::WebdavSynchronizer
 A data synchronizer for WebDAV hosts. More...

Functions

ELEMENTS_API std::string Elements::Services::DataSync::environmentVariable (std::string name)
 Get the value of an environment variable.
ELEMENTS_API std::string Elements::Services::DataSync::getWorkdirVariable ()
 Get the datasync workdir variable.
ELEMENTS_API bool Elements::Services::DataSync::irodsIsInstalled ()
 Check whether the iRODS client is installed.
ELEMENTS_API bool Elements::Services::DataSync::webdavIsInstalled ()
 Check whether the WebDAV client is installed.

Variables

ELEMENTS_API const std::string Elements::Services::DataSync::DEFAULT_WORKDIR_VAR {"WORKSPACE"}
 Name of the default variable that contains the path to the work dir.
ELEMENTS_API const std::string Elements::Services::DataSync::WORKDIR_VAR_VAR {"DATASYNC_WORKDIR_VAR"}
 Name of the variable containing the name of the workspace. It that variable is not set or empty, the content of DEFAULT_WORKDIR_VAR is used as the work dir path.

Detailed Description

Services for runtime and tests.

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (C) 2012-2020 Euclid Science Ground Segment

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Function Documentation

◆ environmentVariable()

string Elements::Services::DataSync::environmentVariable ( std::string name)

Get the value of an environment variable.

Returns
The value if the variable exists; "" otherwise.

Definition at line 86 of file DataSyncUtils.cpp.

References Elements::Environment::get().

Referenced by localWorkspacePrefix().

Here is the call graph for this function:

◆ getWorkdirVariable()

string Elements::Services::DataSync::getWorkdirVariable ( )

Get the datasync workdir variable.

Returns
the name of the variable containing the workdir path

Definition at line 90 of file DataSyncUtils.cpp.

References DEFAULT_WORKDIR_VAR, and WORKDIR_VAR_VAR.

Referenced by localWorkspacePrefix().

◆ irodsIsInstalled()

bool Elements::Services::DataSync::irodsIsInstalled ( )

Check whether the iRODS client is installed.

Definition at line 33 of file IrodsSynchronizer.cpp.

References checkCall().

Referenced by Elements::Services::DataSync::IrodsSynchronizer::IrodsSynchronizer().

Here is the call graph for this function:

◆ webdavIsInstalled()

bool Elements::Services::DataSync::webdavIsInstalled ( )

Check whether the WebDAV client is installed.

Definition at line 33 of file WebdavSynchronizer.cpp.

References checkCall().

Referenced by Elements::Services::DataSync::WebdavSynchronizer::WebdavSynchronizer().

Here is the call graph for this function:

Variable Documentation

◆ DEFAULT_WORKDIR_VAR

const string Elements::Services::DataSync::DEFAULT_WORKDIR_VAR {"WORKSPACE"}

Name of the default variable that contains the path to the work dir.

Definition at line 43 of file DataSyncUtils.cpp.

Referenced by getWorkdirVariable().

◆ WORKDIR_VAR_VAR

const string Elements::Services::DataSync::WORKDIR_VAR_VAR {"DATASYNC_WORKDIR_VAR"}

Name of the variable containing the name of the workspace. It that variable is not set or empty, the content of DEFAULT_WORKDIR_VAR is used as the work dir path.

Definition at line 45 of file DataSyncUtils.cpp.

Referenced by getWorkdirVariable().