updated copyright message

[modules/yacs.git] / src / engine / DataStreamPort.cxx

diff --git a/src/engine/DataStreamPort.cxx b/src/engine/DataStreamPort.cxx
index 07715720e570addfd963a22b5663ff294bab8924..b43af41ab6cbe906db24a303c17b4c33a438cd24 100644 (file)
--- a/src/engine/DataStreamPort.cxx
+++ b/src/engine/DataStreamPort.cxx
@@ -1,3 +1,22 @@
+// Copyright (C) 2006-2023  CEA, EDF
+//
+// 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, 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 #include "DataStreamPort.hxx"
 #include <iostream>
 
@@ -23,19 +42,30 @@ string DataStreamPort::getNameOfTypeOfCurrentInstance() const
   return NAME;
 }
 
+//! Set a new value for a property of the port
+/*!
+ *  \param name : the name property
+ *  \param value : the value property
+ */
 void DataStreamPort::setProperty(const std::string& name, const std::string& value)
 {
   _propertyMap[name]=value;
 }
 
+//! Get the value of a property of the port
+/*!
+ *  \param name : the name property
+ *  \return  the value property
+ */
 std::string DataStreamPort::getProperty(const std::string& name)
 {
   return _propertyMap[name];
 }
-void DataStreamPort::initPortProperties()
-{
-}
 
+//! Set the values of all properties of the port
+/*!
+ *  \param properties : a map containing the values of properties
+ */
 void DataStreamPort::setProperties(std::map<std::string,std::string> properties)
 {
   _propertyMap.clear();
@@ -45,3 +75,12 @@ void DataStreamPort::setProperties(std::map<std::string,std::string> properties)
       setProperty((*it).first, (*it).second); // setProperty virtual and derived
     }
 }
+
+//! Initialize port properties at the start of calculation phase
+/*!
+ *  This method is called before the execution of the parent node.
+ *  It is not used when the user sets properties
+ */
+void DataStreamPort::initPortProperties()
+{
+}