ColCOWS_ObjectDesc.hh

//===========================================================================//
//    
//    Description: interface for user defined event handling classes
//    Filename: colcows/ColCOWS_ObjectDesc.hh
//    Authors: Michael Dussere and Aurélien Esnard
//    
//===========================================================================//
//    
//    Copyright (C) 2003 INRIA and CNRS
//    
//    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
//    
//===========================================================================//

#ifndef __COLCOWS_OBJECT_DESC_HH__
#define __COLCOWS_OBJECT_DESC_HH__

//---------------------------------------------------------------------------//
#include "ColCOWS_Include.hh"
#include "ColCOWS_Debug.hh" 
//---------------------------------------------------------------------------//

namespace CORBA {
  class Object;
}

__COLCOWS_BEGIN__

//! structure describing a remote object 
/** \todo rename with ObjectDesc when the old one will disappear **/
class ObjectDesc 
{

public:
  //! constructor
  ObjectDesc() {}
  
  //! constructor
  ObjectDesc(std::string id, std::string kind, CORBA::Object * ref) : 
    obj_id(id), obj_kind(kind), obj_ref(ref) {}

  //! destructor
  virtual ~ObjectDesc() {}
  
  //! print self
  inline virtual void printself(std::ostream & stream, int indent = 0) const 
  {
    std::string space; 
    for(int i = 0; i < indent; i++, space += COLCOWS_TAB);
    stream << space << std::flush;
    stream << " ID: " << obj_id << std::flush;
    stream << " kind: " << obj_kind << std::flush;
  }


public:

  //! CORBA object Id
  std::string        obj_id;

  //! CORBA object kind
  std::string        obj_kind;

  //! CORBA object reference
  CORBA::Object * obj_ref;

};

//! Extended description of remote object
class ExtObjectDesc : public ObjectDesc
{

public:
  //! constructor
  ExtObjectDesc() {}

  //! constructor
  ExtObjectDesc(ObjectDesc obj_desc) : ObjectDesc(obj_desc) {}

  //! destructor
  virtual ~ExtObjectDesc() {}  

  //! print self
  inline virtual void printself(std::ostream & stream, int indent = 0) const 
  {
    ObjectDesc::printself( stream, indent);
    stream << " Num Connection: " << num_connection << std::flush;
    stream << " Num Node: " << num_node << std::flush;
  }

public:

  //! Number of connection of the remote workspace owning this object
  unsigned long      num_connection;

  //! Number of the remote node owning this object
  unsigned long      num_node;

};

typedef std::vector< ExtObjectDesc > ExtObjectDescVec;
  
//------------------------------------------------------------------------// 

//! standard output stream operator
inline std::ostream & operator <<(std::ostream & stream, const ObjectDesc & _this)
{
  stream << "ObjectDesc { " << std::flush;
  _this.printself(stream);
  stream << "}" << std::flush;
  return stream;
}

//------------------------------------------------------------------------// 

//! standard output stream operator
inline std::ostream & operator <<(std::ostream & stream, const ExtObjectDesc & _this)
{
  stream << "ExtObjectDesc { " << std::flush;
  _this.printself(stream);
  stream << "}" << std::flush;
  return stream;
}

//------------------------------------------------------------------------// 

__COLCOWS_END__

#endif // __COLCOWS_NODE_DESC_HH__

// EOF

---