handleValSet.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: handleValSet.h,v $ $Revision: 1.20 $ $State: Exp $
*********************************************************************/


#ifdef DtIFSPEC13
#ifdef DtIFSPEC13DLC
#include "RTI13.h"
#define RTI rti13
#else
#include "RTI.hh"
#endif
#include "attrInfo.h"
#include "attrVal.h"

#ifdef DDM
#include "region13.h"
class DtRegion;
#endif

class DtObjectClassInfo;

class DT_DLL_LRC DtHvps : public RTI::HandleValuePairSet
{
public:

   DtHvps(RTI::ULong count, RTI::Handle handle = theDefaultChannel);

   virtual ~DtHvps();

   virtual RTI::ULong size() const;

   virtual RTI::Handle getHandle(RTI::ULong i) const
      throw (
         RTI::ArrayIndexOutOfBounds);

   virtual RTI::ULong getValueLength(RTI::ULong i) const
      throw (
         RTI::ArrayIndexOutOfBounds);

   virtual void getValue(RTI::ULong i, char *buff,  
      RTI::ULong &valueLength) const
      throw (
         RTI::ArrayIndexOutOfBounds);

   virtual char *getValuePointer(
      RTI::ULong i, RTI::ULong& valueLength) const
      throw (
         RTI::ArrayIndexOutOfBounds);
  
#ifdef DtDEFINING_AHVPS
   virtual RTI::TransportType getTransportType( RTI::ULong i) const
      throw (
         RTI::ArrayIndexOutOfBounds,
         RTI::InvalidHandleValuePairSetContext);

   virtual RTI::OrderType getOrderType( RTI::ULong i) const
      throw (
         RTI::ArrayIndexOutOfBounds,
         RTI::InvalidHandleValuePairSetContext);

   virtual RTI::Region *getRegion(RTI::ULong i) const
      throw (
         RTI::ArrayIndexOutOfBounds,
         RTI::InvalidHandleValuePairSetContext);

   virtual void print(DtObjectClassInfo* fomClass) const;    

#else
   virtual RTI::TransportType getTransportType() const
      throw (RTI::InvalidHandleValuePairSetContext);

   virtual RTI::OrderType getOrderType() const
      throw (RTI::InvalidHandleValuePairSetContext);

   virtual RTI::Region *getRegion() const
      throw (RTI::InvalidHandleValuePairSetContext);

   virtual void print(DtInteractionClassInfo* fomClass) const;    

#endif

   virtual void add(
      RTI::Handle h,
      const char *buff,
      RTI::ULong valueLength)
      throw (
         RTI::ValueLengthExceeded,
         RTI::ValueCountExceeded);

   virtual void addPointer(
      RTI::Handle h,
      const char *buff,
      RTI::ULong valueLength)
      throw (
         RTI::ValueLengthExceeded,
         RTI::ValueCountExceeded);

   virtual void remove(RTI::Handle h)
      throw (
         RTI::ArrayIndexOutOfBounds);
   
   virtual void moveFrom(const RTI::HandleValuePairSet& ahvp,
      RTI::ULong &i)
      throw (
         RTI::ValueCountExceeded,
         RTI::ArrayIndexOutOfBounds);

   virtual void empty();

   virtual void print() const;

   virtual RTI::ULong start() const;
   virtual RTI::ULong valid(RTI::ULong i) const;
   virtual RTI::ULong next(RTI::ULong i) const;

   virtual void setChannel(RTI::Handle channelValue);
   virtual RTI::Handle channel() const;

#ifdef DDM
   virtual void setRegion(DtRegion* region);
#endif
   virtual void setTransportType(RTI::TransportationHandle type);
   virtual RTI::TransportationHandle transportType() const;

   virtual void setOrderType(RTI::OrderingHandle type);
   virtual RTI::OrderingHandle orderType() const;

   virtual void setOffset(unsigned int offset);
   virtual void setMinOffset(unsigned int offset);
   virtual unsigned int offset(void) const ;

public:
   static void setDefaultChannel(RTI::Handle defaultChannelValue);
   static RTI::Handle defaultChannel();

protected:
   static RTI::Handle theDefaultChannel;

protected:
   RTI::ULong myMaxSize;
   RTI::ULong mySize;
   RTI::Handle myChannel;
   RTI::TransportationHandle myTransport;
   RTI::OrderingHandle myOrder;
   DtAttrVal **myVals;
#ifdef DDM
   DtRegion13 myRegion;
#endif
   unsigned int myUpdateRateOffset;
};

#ifndef __alpha
inline RTI::ULong DtHvps::start() const
{
   return 0;
}

inline RTI::ULong DtHvps::valid(RTI::ULong i) const
{
   return (i >= start() && i < size());
}

inline RTI::ULong DtHvps::next(RTI::ULong i) const
{
   return i+1;
}
#endif

#endif