From 0ac192d648f2e2c7f2c34a885dfea0799ad1f630 Mon Sep 17 00:00:00 2001 From: ribes Date: Wed, 7 Mar 2007 13:12:14 +0000 Subject: [PATCH] Doxygen documentation, english comments. --- src/DSC/DSC_User/Basic/basic_port_factory.cxx | 24 ++++++++- src/DSC/DSC_User/Basic/basic_port_factory.hxx | 44 +++++++++++++++- .../Basic/data_short_port_provides.cxx | 30 ++++++++--- .../Basic/data_short_port_provides.hxx | 45 +++++++++++++++- .../DSC_User/Basic/data_short_port_uses.cxx | 24 ++++++++- .../DSC_User/Basic/data_short_port_uses.hxx | 51 ++++++++++++++++++- 6 files changed, 206 insertions(+), 12 deletions(-) diff --git a/src/DSC/DSC_User/Basic/basic_port_factory.cxx b/src/DSC/DSC_User/Basic/basic_port_factory.cxx index c2f51c86a..4d7d4a75d 100644 --- a/src/DSC/DSC_User/Basic/basic_port_factory.cxx +++ b/src/DSC/DSC_User/Basic/basic_port_factory.cxx @@ -1,5 +1,27 @@ -// André Ribes - EDF R&D 2006 +// Copyright (C) 2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// 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 2.1 of the License. +// +// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // +// +// +// File : basic_port_factory.cxx +// Author : André RIBES (EDF) +// Module : KERNEL #include "basic_port_factory.hxx" diff --git a/src/DSC/DSC_User/Basic/basic_port_factory.hxx b/src/DSC/DSC_User/Basic/basic_port_factory.hxx index eede4d7ea..7550ffaee 100644 --- a/src/DSC/DSC_User/Basic/basic_port_factory.hxx +++ b/src/DSC/DSC_User/Basic/basic_port_factory.hxx @@ -1,5 +1,27 @@ -// André Ribes - EDF R&D 2006 +// Copyright (C) 2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// 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 2.1 of the License. +// +// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // +// +// +// File : basic_port_factory.hxx +// Author : André RIBES (EDF) +// Module : KERNEL #ifndef _BASIC_PORT_FACTORY_HXX_ #define _BASIC_PORT_FACTORY_HXX_ @@ -9,13 +31,33 @@ using namespace std; +/*! \class basic_port_factory + * \brief This class is an example of factory for DSC_User ports. + * + * This class implements the methods to be able + * to be used by Superv_Component_i. + * It builds basic ports. + */ class basic_port_factory { public: basic_port_factory(); virtual ~basic_port_factory(); + /*! + * This method creates a provides port of Basic ports. + * + * \param type the basic port's type. + * \return a pointer of the provides port. + */ virtual provides_port * create_data_servant(string type); + + /*! + * This method creates a uses port of Basic ports. + * + * \param type the basic port's type. + * \return a pointer of the uses port. + */ virtual uses_port * create_data_proxy(string type); }; diff --git a/src/DSC/DSC_User/Basic/data_short_port_provides.cxx b/src/DSC/DSC_User/Basic/data_short_port_provides.cxx index 82209e6ea..08723ec70 100644 --- a/src/DSC/DSC_User/Basic/data_short_port_provides.cxx +++ b/src/DSC/DSC_User/Basic/data_short_port_provides.cxx @@ -1,5 +1,28 @@ -// André Ribes EDF R&D - 2006 +// Copyright (C) 2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS // +// 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 2.1 of the License. +// +// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// +// +// +// File : data_short_port_provides.cxx +// Author : André RIBES (EDF) +// Module : KERNEL + #include "data_short_port_provides.hxx" data_short_port_provides::data_short_port_provides() { @@ -18,11 +41,6 @@ data_short_port_provides::get() { return _val; } -CORBA::Short -data_short_port_provides::get_local() { - return _val; -} - Ports::Port_ptr data_short_port_provides::get_port_ref() { return this->_this(); diff --git a/src/DSC/DSC_User/Basic/data_short_port_provides.hxx b/src/DSC/DSC_User/Basic/data_short_port_provides.hxx index 257bd8e13..2c5adca40 100644 --- a/src/DSC/DSC_User/Basic/data_short_port_provides.hxx +++ b/src/DSC/DSC_User/Basic/data_short_port_provides.hxx @@ -1,5 +1,27 @@ -// André Ribes EDF R&D - 2006 +// Copyright (C) 2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS // +// 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 2.1 of the License. +// +// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// +// +// +// File : data_short_port_provides.hxx +// Author : André RIBES (EDF) +// Module : KERNEL #ifndef _DATA_SHORT_PORT_PROVIDES_HXX_ #define _DATA_SHORT_PORT_PROVIDES_HXX_ @@ -8,6 +30,10 @@ #include "SALOME_Ports.hh" #include "provides_port.hxx" +/*! \class data_short_port_provides + * \brief This class a port that sends a CORBA short with + * the basic port policy. + */ class data_short_port_provides : public virtual POA_Ports::Data_Short_Port, public virtual provides_port @@ -16,10 +42,25 @@ class data_short_port_provides : data_short_port_provides(); virtual ~data_short_port_provides(); + /*! + * This method implements the CORBA method of the interface. + * \see Ports::Data_Short_Port::put + */ virtual void put(CORBA::Short data); + + /*! + * This method is used by the component to get + * the last value received. + * + * \return the last value received (default 0). + */ virtual CORBA::Short get(); - virtual CORBA::Short get_local(); + /*! + * This method gives the port CORBA reference. + * + * \return port's CORBA reference. + */ virtual Ports::Port_ptr get_port_ref(); private : diff --git a/src/DSC/DSC_User/Basic/data_short_port_uses.cxx b/src/DSC/DSC_User/Basic/data_short_port_uses.cxx index c9c02d58d..70216b465 100644 --- a/src/DSC/DSC_User/Basic/data_short_port_uses.cxx +++ b/src/DSC/DSC_User/Basic/data_short_port_uses.cxx @@ -1,5 +1,27 @@ -// André Ribes EDF R&D - 2006 +// Copyright (C) 2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// 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 2.1 of the License. +// +// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // +// +// +// File : data_short_port_uses.cxx +// Author : André RIBES (EDF) +// Module : KERNEL #include "data_short_port_uses.hxx" #include diff --git a/src/DSC/DSC_User/Basic/data_short_port_uses.hxx b/src/DSC/DSC_User/Basic/data_short_port_uses.hxx index f1ab8c63a..7a28693b6 100644 --- a/src/DSC/DSC_User/Basic/data_short_port_uses.hxx +++ b/src/DSC/DSC_User/Basic/data_short_port_uses.hxx @@ -1,5 +1,27 @@ -// André Ribes EDF R&D - 2006 +// Copyright (C) 2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// 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 2.1 of the License. +// +// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // +// +// +// File : data_short_port_uses.hxx +// Author : André RIBES (EDF) +// Module : KERNEL #ifndef _DATA_SHORT_PORT_USES_HXX_ #define _DATA_SHORT_PORT_USES_HXX_ @@ -7,6 +29,10 @@ #include "uses_port.hxx" #include "SALOME_Ports.hh" +/*! \class data_short_port_uses + * \brief This class a port that sends a CORBA short with + * the basic port policy. + */ class data_short_port_uses : public virtual uses_port { @@ -14,11 +40,34 @@ class data_short_port_uses : data_short_port_uses(); virtual ~data_short_port_uses(); + /*! + * This method is used by the component to get + * port's CORBA repository id + * + * \return port's CORBA repository id + */ virtual const char * get_repository_id(); + + /*! + * \warning deprecated + */ virtual bool set_port(Ports::Port_ptr port); + /*! + * This method is used by the component to send + * a short value to all the provides ports connected. + * + * \param data the short sended. + */ virtual void put(CORBA::Short data); + /*! + * This method is a callback for be aware of modification + * of the port's connections. + * + * \param new_uses_port the new uses port's sequence. + * \param message message associated to the modification. + */ virtual void uses_port_changed(Engines::DSC::uses_port * new_uses_port, const Engines::DSC::Message message); -- 2.39.2