ComponentInterface.ice

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * package    navigation::room_editor
 * author     Fabian Reister ( fabian dot reister at kit dot edu )
 * date       2026
 * copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *            GNU General Public License
 */
 
 
#pragma once
 
 
module armarx {  module navigation {  module components {  module room_editor
{
 
    interface ComponentInterface
    {
        /**
         * Re-reads the rooms from the navigation memory.
         * As every edit is written back immediately, this only matters if the
         * rooms were changed by somebody else.
         */
        void reloadFromMemory();
 
        /**
         * Dumps the rooms of the navigation memory to disk (`rooms.json`),
         * using the package and directory configured via the properties or the Remote GUI.
         */
        bool exportToJson();
    };
 
};};};};