Commit 06d092bb authored by Ulrich Kemloh's avatar Ulrich Kemloh

Documentation, adding headers and licences

parent 6effc948
......@@ -48,8 +48,6 @@
#define _SIMULATOR 1
//#define _USE_PROTOCOL_BUFFER 1
#define JPS_OLD_VERSION "0.5" // this version is still supported
#define JPS_VERSION_MINOR "6"
#define JPS_VERSION_MAJOR "0"
......
......@@ -845,7 +845,7 @@ bool NormalSubRoom::ConvertLineToPoly(const vector<Line*>& goals)
IsElementInVector(_poly,g->GetPoint2())) )
{
Log->Write("ERROR:\t goal was not used during polygon creation for subroom: %s",g->toString().c_str());
return false;
//return false;
}
}
return true;
......
......@@ -34,7 +34,7 @@ xsi:noNamespaceSchemaLocation="http://xsd.jupedsim.org/0.6/jps_ini_core.xsd">
<!--persons information and distribution -->
<agents operational_model_id="2">
<agents_distribution>
<group group_id="0" agent_parameter_id="1" room_id="0" subroom_id="0" number="1" goal_id="-1" router_id="1" pre_movement_mean="15" pre_movement_sigma="0.4"/>
<group group_id="0" agent_parameter_id="1" room_id="0" subroom_id="0" number="100" goal_id="-1" router_id="1" pre_movement_mean="15" pre_movement_sigma="0.4"/>
</agents_distribution>
</agents>
......
/*
* HybridSimulationManager.cpp
/**
* \file HybridSimulationManager.cpp
* \date Apr 20, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: Apr 20, 2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class manages the hybrid simulation by connecting to a server, receiving information and launching a simulation.
* It makes use of the google protocol buffer (https://github.com/google/protobuf)
* as serializing technique and grpc (https://github.com/grpc/) for the communication across the network.
*
**/
#include "HybridSimulationManager.h"
#include "MATSimInterface.pb.h"
......
/*
* HybridSimulationManager.h
/**
* \file HybridSimulationManager.h
* \date Apr 20, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: Apr 20, 2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class manages the hybrid simulation by connecting to a server, receiving information and launching a simulation.
* It makes use of the google protocol buffer (https://github.com/google/protobuf)
* as serializing technique and grpc (https://github.com/grpc/) for the communication across the network.
*
**/
#ifndef HYBRIDSIMULATIONMANAGER_H_
#define HYBRIDSIMULATIONMANAGER_H_
......
/*
* JPSclient.cpp
/**
* \file JPSclient.cpp
* \date Apr 21, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: Apr 21, 2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class uses the channel created by the grpc to send information to the client.
*
**/
#include "JPSclient.h"
#include "../pedestrian/Pedestrian.h"
......
/*
* JPSclient.h
/**
* \file JPSclient.h
* \date Apr 21, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: Apr 21, 2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class uses the channel created by the grpc to send information to the client.
*
**/
#ifndef MATSIM_JPSCLIENT_H_
#define MATSIM_JPSCLIENT_H_
......
/*
* JPSserver.cpp
/**
* \file JPSserver.cpp
* \date Apr 21, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: Apr 21, 2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class implements the remote procedure calls methods defined in the matsim.proto interface.
* These methods are then called by the remote program via the channel created.
*
**/
#include "JPSserver.h"
#include "JPSclient.h"
......
/*
* JPSserver.h
/**
* \file JPSserver.h
* \date Apr 21, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: Apr 21, 2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class implements the remote procedure calls methods defined in the matsim.proto interface.
* These methods are then called by the remote program via the channel created.
*
**/
#ifndef MATSIM_JPSSERVER_H_
#define MATSIM_JPSSERVER_H_
......
/*
* AgentsQueue.cpp
/**
* \file AgentsQueue.cpp
* \date Apr 14, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: 14.04.2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
*
**/
#include "AgentsQueue.h"
......
/*
* AgentsQueue.h
/**
* \file AgentsQueue.h
* \date Apr 14, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: 14.04.2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
*
**/
#ifndef AGENTSQUEUE_H_
#define AGENTSQUEUE_H_
......
/*
* AgentSource.cpp
/**
* \file AgentSource.cpp
* \date Apr 04, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: 14.04.2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class is responsible for materialising agent in a given location at a given frequency up to a maximum number.
* The optimal position where to put the agents is given by various algorithms, for instance
* the Voronoi algorithm or the Mitchell Best candidate algorithm.
*
**/
#include "AgentsSource.h"
#include "Pedestrian.h"
......
/*
* AgentSource.h
/**
* \file AgentSource.h
* \date Apr 04, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: 14.04.2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class is responsible for materialising agent in a given location at a given frequency.
* The optimal position where to put the agents is given by various algorithms, for instance
* the Voronoi algorithm or the Mitchell Best candidate algorithm.
*
**/
#ifndef AGENTSOURCE_H_
#define AGENTSOURCE_H_
......
/*
* AgentsSourcesManager.cpp
/**
* \file AgentsSourcesManager.cpp
* \date Apr 14, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: 14.04.2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class is responsible for materialising agent in a given location at a given frequency up to a maximum number.
* The optimal position where to put the agents is given by various algorithms, for instance
* the Voronoi algorithm or the Mitchell Best candidate algorithm.
*
**/
#include "AgentsSourcesManager.h"
#include "Pedestrian.h"
......
/*
* AgentsSourcesManager.h
/**
* \file AgentsSourcesManager.h
* \date Apr 14, 2015
* \version v0.6
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Created on: 14.04.2015
* Author: piccolo
*/
* \section License
* This file is part of JuPedSim.
*
* JuPedSim 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 of the License, or
* any later version.
*
* JuPedSim 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 Lesser General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section Description
* This class is responsible for materialising agent in a given location at a given frequency up to a maximum number.
* The optimal position where to put the agents is given by various algorithms, for instance
* the Voronoi algorithm or the Mitchell Best candidate algorithm.
*
**/
#ifndef AGENTSSOURCESMANAGER_H_
#define AGENTSSOURCESMANAGER_H_
......
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