counter.h

Go to the documentation of this file.

/*_############################################################################
  _## 
  _##  counter.h  
  _##
  _##  SNMP++ v3.3
  _##  -----------------------------------------------
  _##  Copyright (c) 2001-2013 Jochen Katz, Frank Fock
  _##
  _##  This software is based on SNMP++2.6 from Hewlett Packard:
  _##  
  _##    Copyright (c) 1996
  _##    Hewlett-Packard Company
  _##  
  _##  ATTENTION: USE OF THIS SOFTWARE IS SUBJECT TO THE FOLLOWING TERMS.
  _##  Permission to use, copy, modify, distribute and/or sell this software 
  _##  and/or its documentation is hereby granted without fee. User agrees 
  _##  to display the above copyright notice and this license notice in all 
  _##  copies of the software and any documentation of the software. User 
  _##  agrees to assume all liability for the use of the software; 
  _##  Hewlett-Packard and Jochen Katz make no representations about the 
  _##  suitability of this software for any purpose. It is provided 
  _##  "AS-IS" without warranty of any kind, either express or implied. User 
  _##  hereby grants a royalty-free license to any and all derivatives based
  _##  upon this software code base. 
  _##  
  _##########################################################################*/
/*===================================================================

  Copyright (c) 1999
  Hewlett-Packard Company

  ATTENTION: USE OF THIS SOFTWARE IS SUBJECT TO THE FOLLOWING TERMS.
  Permission to use, copy, modify, distribute and/or sell this software
  and/or its documentation is hereby granted without fee. User agrees
  to display the above copyright notice and this license notice in all
  copies of the software and any documentation of the software. User
  agrees to assume all liability for the use of the software; Hewlett-Packard
  makes no representations about the suitability of this software for any
  purpose. It is provided "AS-IS without warranty of any kind,either express
  or implied. User hereby grants a royalty-free license to any and all
  derivatives based upon this software code base.


  SNMP++ C O U N T E R. H

  COUNTER32 CLASS DEFINITION

  DESIGN + AUTHOR:  Peter E Mellquist

  DESCRIPTION:
  Class definition for SMI Counter32 class.

=====================================================================*/
// $Id: counter.h 2359 2013-05-09 20:07:01Z fock $

#ifndef _COUNTER
#define _COUNTER

#include "snmp_pp/integer.h"

#ifdef SNMP_PP_NAMESPACE
namespace Snmp_pp {
#endif

//------------[ Counter32 Class ]------------------------------------------
/**
 * The counter class allows all the functionality of unsigned
 * integers but is recognized as a distinct SMI type. Counter32
 * class objects may be set or get into Vb objects.
 */
class DLLOPT Counter32: public SnmpUInt32
{
 public:
#if 0
  /**
   * Constructor to create a Counter object with value zero.
   */
  Counter32() : SnmpUInt32() { smival.syntax = sNMP_SYNTAX_CNTR32; };
#endif

  /**
   * Constructor with a value - defaults to 0.
   *
   * @param i - unsigned 32 bit value
   */
  Counter32(const unsigned long i = 0)
    : SnmpUInt32(i)
  {
    smival.syntax = sNMP_SYNTAX_CNTR32;
  }

  /**
   * Copy constructor.
   *
   * @param c - Object to copy from
   */
  Counter32(const Counter32 &c)
    : SnmpUInt32(c)
  {
    smival.syntax = sNMP_SYNTAX_CNTR32;
  }

  /**
   * Return the syntax.
   *
   * @return Returns always sNMP_SYNTAX_CNTR32
   */
  SmiUINT32 get_syntax() const { return sNMP_SYNTAX_CNTR32; }

  /**
   * Clone operator.
   *
   * @return Pointer to a newly created copy of the object.
   */
  SnmpSyntax *clone() const { return (SnmpSyntax *)new Counter32(*this); }

  /**
   * Map other SnmpSyntax objects to Counter32.
   */
  // SnmpSyntax& operator=(const SnmpSyntax &val);
  using SnmpUInt32::operator = ;

  /**
   * Overloaded assignment for Counter32.
   *
   * @param uli - new value
   * @return self reference
   */
  Counter32& operator=(const Counter32 &uli)
  {
    smival.value.uNumber = uli.smival.value.uNumber;
    valid_flag = uli.valid_flag;
    m_changed = true;
    return *this;
  }

  /**
   * Overloaded assignment for unsigned longs.
   *
   * @param ul - new value
   * @return self reference
   */
  Counter32& operator=(const unsigned long ul)
  {
    SnmpUInt32::operator = (ul);
    return *this;
  }

#if 0
  // XXX this operator is already provided by SnmpUInt32
  /**
   * Casting to unsigned long.
   *
   * @return Current value as an unsigned long
   */
  operator unsigned long() { return smival.value.uNumber; };
#endif
};

#ifdef SNMP_PP_NAMESPACE
} // end of namespace Snmp_pp
#endif 

#endif // _COUNTER