Commit daa256ff authored by Emmanuelle Sarrazin's avatar Emmanuelle Sarrazin

Module initialisation

parents
cmake_minimum_required(VERSION 2.8.9)
project(MPIModule)
set(MPIModule_LIBRARIES MPIModule)
if(NOT OTB_SOURCE_DIR)
find_package(OTB REQUIRED)
set(OTB_CMAKE_DIR /work/hpc/sarrazie/otb/OTB-develop/CMake/)
set(OTB_SOURCE_DIR /work/hpc/sarrazie/otb/OTB-develop/)
list(APPEND CMAKE_MODULE_PATH ${OTB_CMAKE_DIR})
include(OTBModuleExternal)
else()
otb_module_impl()
endif()
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
General
=======
This is a template module for the ORFEO
Toolbox(https://www.orfeo-toolbox.org/). It is designed to work with OTBv5
modular system and to be places in OTB/Module/Remote.
This module is empty it is just a template to be used as a starting point for a
module with actual content. It contains the template for sources (src folder),
test (test folder) and application (app folder).
Getting Started
===============
The official OTB Wiki documentation on adding an external module is here:
http://wiki.orfeo-toolbox.org/index.php/How_to_write_a_remote_module
Remote Module
-------------
After a module has been created as a git repository it can be included
as a remote module, which enables automatic fetching. Add a file in
"OTB/Modules/Remote" called "YourModule.remote.cmake", for this module
it would be "ExternalExample.remote.cmake" with the followlowing contents:
otb_fetch_module(ExternalTemplate
"A template for a module."
GIT_REPOSITORY https://github.com/orfeotoolbox/otbExternalModuleTemplate
GIT_TAG master
)
Editing
=======
The CMakeLists.txt and otb-modules need to be modified with the name of the
module, something along the following:
sed 's/ExternalTemplate/MyModule/g' CMakeLists.txt otb-module.cmake
There is the inplace option to sed, but it's not portable, so do this change by
hand or look up the option in sed.
Then hack away at you code in include, src, test and app folders.
License
=======
This software is distributed under the Apache License. Please see LICENSE for
details.
Author
======
Manuel Grizonnet
Thanks
======
It is a fork of the ITK template module provided by Bradley Lowekamp
(https://github.com/blowekamp/itkExternalTemplate.git) which was adapted for the
ORFEO ToolBox.
OTB_CREATE_APPLICATION(NAME MPIHelloApp
SOURCES otbMPIHelloApp.cxx
LINK_LIBRARIES ${${otb-module}_LIBRARIES}
)
#include "otbWrapperApplication.h"
#include "otbWrapperApplicationFactory.h"
class EmptyApp : public otb::Wrapper::Application
{
public:
typedef EmptyApp Self;
typedef itk::SmartPointer<Self> Pointer;
itkNewMacro(Self);
itkTypeMacro(EmptyApp, otb::Wrapper::Application);
private:
void DoInit()
{
SetName("EmptyApp");
SetDescription("Empty application.");
}
void DoUpdateParameters()
{
}
void DoExecute()
{
int ThisDoesNothing = 0;
}
};
OTB_APPLICATION_EXPORT(EmptyApp)
/*=========================================================================
Program: ORFEO Toolbox
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
See OTBCopyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __MPIConfig_h
#define __MPIConfig_h
#include <mpi.h>
namespace otb
{
namespace mpi
{
/** \class MPIConfig
*
* Manage MPI ressources
*
*/
class MPIConfig
{
public:
/**
* Initialize the MPI environment.
*
* If the MPI environment has not already been initialized,
* initializes MPI with a call to MPI_Init.
*
* @param argc Number of arguments
*
* @param argv Array of arguments
*
* @param abort_on_exception When true, this object will abort the
* program if it is destructed due to an uncaught exception.
*/
MPIConfig(int& argc, char** &argv, bool abortOnException = true);
/**
* Shuts down the MPI environment.
*/
~MPIConfig();
/**
* Abort all MPI processes.
*
* @param errcode
*/
void abort(int errcode);
/**
* Determine if the MPI environment has already been initialized.
*
* @returns @c true if the MPI environment has been initialized.
*/
bool initialized();
/**
* Determine if the MPI environment has already been finalized.
*
* @returns @c true if the MPI environment has been finalized.
*/
bool finalized();
private:
/// Whether this environment object called MPI_Init
bool m_initialized;
/// Whether we should abort if the destructor is
bool m_abortOnException;
};
} // end namespace mpi
} // end namespace otb
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbMPIConfig.txx"
#endif
#endif // MPIConfig
#include "otbMPIConfig.h"
set(DOCUMENTATION "OTB module template.")
# OTB_module() defines the module dependencies in ExternalTemplate
# ExternalTemplate depends on OTBCommon and OTBApplicationEngine
# The testing module in ExternalTemplate depends on OTBTestKernel
# and OTBCommandLine
# define the dependencies of the include module and the tests
otb_module(MPIModule
DEPENDS
OTBMPI
OTBCommon
OTBApplicationEngine
TEST_DEPENDS
OTBMPI
OTBTestKernel
OTBCommandLine
DESCRIPTION
"${DOCUMENTATION}"
)
#${otb-module} will be the name of this module and will not need to be
#changed when this module is renamed.
set(${otb-module}_SRC
otbMPIConfig.cpp
)
add_library(${otb-module} ${${otb-module}_SRC})
target_link_libraries(${otb-module} ${OTBCommon_LIBRARIES})
otb_module_target(${otb-module})
/*=========================================================================
Program: ORFEO Toolbox
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
See OTBCopyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#include "otbMPIConfig.h"
#include <exception>
namespace otb
{
namespace mpi
{
MPIConfig::MPIConfig(int& argc, char** &argv, bool abortOnException)
: m_initialized(false),
m_abortOnException(abortOnException)
{
if (!initialized()) {
MPI_Init, (&argc, &argv);
m_initialized = true;
}
}
MPIConfig::~MPIConfig()
{
}
void MPIConfig::abort(int errcode)
{
}
bool MPIConfig::initialized()
{
int flag;
return flag != 0;
}
bool MPIConfig::finalized()
{
int flag;
return flag != 0;
}
} // End namespace mpi
} // end namespace otb
otb_module_test()
#${otb-module} will be the name of this module and will not need to be
#changed when this module is renamed.
set(${otb-module}Tests
otbMPIModuleTestDriver.cxx
otbMPIHelloTest.cxx
)
add_executable(otbMPIModuleTestDriver ${${otb-module}Tests})
target_link_libraries(otbMPIModuleTestDriver ${${otb-module}-Test_LIBRARIES})
otb_module_target_label(otbMPIModuleTestDriver)
otb_add_test(NAME otbMPIHelloTest
COMMAND otbMPIModuleTestDriver otbMPIHelloTest)
#test application
otb_test_application(NAME otbMPIHelloAppTest
APP MPIHelloApp)
#include <cstdlib>
int otbEmptyTest( int , char ** )
{
return EXIT_SUCCESS;
}
#include "otbTestMain.h"
void RegisterTests()
{
REGISTER_TEST(otbEmptyTest);
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment