GroupInfo.h

// --------------------- -*- c++ -*- ----------------------
// $Id: GroupInfo.h,v 1.11 2006/05/01 18:10:32 kasemir Exp $
//
// Please refer to NOTICE.txt,
// included as part of this distribution,
// for legal information.
//
// Kay-Uwe Kasemir, kasemir@lanl.gov
// --------------------------------------------------------
#ifndef __GROUPINFO_H__
#define __GROUPINFO_H__

#include <stdlib.h>

// epics
#include <epicsTime.h>

#include "tools/ToolsConfig.h"
#include "tools/Guard.h"
#include "tools/FUX.h"

class ArchiveChannel;

// engine
#include "engine/Named.h"

class GroupInfo : public NamedBase, public Guardable {

public:

  GroupInfo(const std::string &name);
    
  virtual ~GroupInfo();

  inline OrderedMutex& getMutex();
    
  void addChannel(Guard &group_guard, ArchiveChannel* channel);

  const stdList<class ArchiveChannel *>& 
  getChannels(Guard& group_guard) const;
    
  void disable(Guard& group_guard,
               ArchiveChannel* cause, 
               const epicsTime& when);

  void enable(Guard& group_guard,
              ArchiveChannel* cause, 
              const epicsTime& when);
    
  inline bool isEnabled(Guard& group_guard) const;

  inline size_t getNumConnected(Guard &group_guard) const;
    
  void incConnected(Guard& group_guard, ArchiveChannel& pv);
    
  void decConnected(Guard& group_guard, ArchiveChannel& pv);
    
  void addToFUX(Guard& group_guard, FUX::Element* doc);

private:

    GroupInfo(const GroupInfo &); // not impl.
    GroupInfo & operator = (const GroupInfo &); // not impl.

    OrderedMutex mutex;   

    stdList<ArchiveChannel *> channels; 
    size_t num_connected;
    size_t disable_count;  // disabled by how many channels?
};

inline OrderedMutex& GroupInfo::getMutex() {
  return mutex;
}

inline bool GroupInfo::isEnabled(Guard& group_guard) const {
  return disable_count <= 0;
}

inline size_t GroupInfo::getNumConnected(Guard& group_guard) const {
  return num_connected;
}    

#endif //__GROUPINFO_H__