OID.hpp

Go to the documentation of this file.

// SNMPpp: https://sourceforge.net/p/snmppp/
// SNMPpp project uses the MIT license. See LICENSE for details.
// Copyright (C) 2013 Stephane Charette <stephanecharette@gmail.com>

#pragma once

#include <map>
#include <set>
#include <vector>
#include <string>
#include <ostream>
#include <SNMPpp/net-snmppp.hpp>


namespace SNMPpp
{
    class OID
    {
        public:

            enum ECommon
            {
                // several common locations useful as a starting point
                kInvalid            = 0,    
                kEmpty              = 1,    
                kInternet           = 2,    
                kPrivateEnterprise  = 3,    
                kSysUpTime          = 4,    
                kTrap               = 5     
            };

            enum ENameLookup
            {
                kUnknown    = 0,
                kLeafOnly   = 1,
                kPartial    = 2,
                kInverted   = 3,
                kFull       = 4
            };

            virtual ~OID( void );

            OID( void );

            OID( const OID &oid );

            OID( const char * const s );

            OID( const std::string &s );

            OID( const SNMPpp::OID::ECommon &location );

            OID( const oid * o, const size_t len );

            explicit OID( const netsnmp_variable_list *vl );

            virtual operator std::string( void ) const;

            virtual std::string to_str( void ) const { return operator std::string(); }

            virtual operator const oid *( void ) const;

            virtual operator oid *( void );

            virtual operator const unsigned char *( void ) const { return (unsigned char *)operator const oid*(); }

            virtual operator const void *( void ) const { return (void*)operator const oid*(); }

            virtual OID &clear( void );

            virtual bool empty( void ) const { return v.empty(); }

            virtual operator bool( void ) const { return ! empty(); }

            virtual operator size_t( void ) const { return v.size(); }

            virtual size_t size( void ) const { return v.size(); }

            virtual size_t len( void ) const { return v.size(); }

            virtual bool operator< ( const SNMPpp::OID &rhs ) const { return v <  rhs.v; }
            virtual bool operator<=( const SNMPpp::OID &rhs ) const { return v <= rhs.v; }
            virtual bool operator> ( const SNMPpp::OID &rhs ) const { return v >  rhs.v; }
            virtual bool operator>=( const SNMPpp::OID &rhs ) const { return v >= rhs.v; }
            virtual bool operator==( const SNMPpp::OID &rhs ) const { return v == rhs.v; }
            virtual bool operator!=( const SNMPpp::OID &rhs ) const { return v != rhs.v; }

            virtual OID operator+ ( const oid o ) const;

            virtual OID &operator+=( const oid o );

            virtual OID  operator+ ( const std::string &s ) const;

            virtual OID &operator+=( const std::string &s );

            virtual oid operator[]( const size_t idx ) const;

            virtual OID &set( const OID &oid );

            virtual OID &set( const char * const s );

            virtual OID &set( const std::string &s );

            virtual OID &set( const SNMPpp::OID::ECommon &location );

            virtual OID &operator=( const std::string &s ) { return set( s ); }

            virtual OID &operator=( const char * const s ) { return set( s ); }

            virtual bool isChildOf(  const SNMPpp::OID &rhs ) const;

            virtual bool isParentOf( const SNMPpp::OID &rhs ) const;

            virtual bool isImmediateChildOf ( const SNMPpp::OID &rhs ) const;

            virtual bool isImmediateParentOf( const SNMPpp::OID &rhs ) const;

            virtual OID parent( const size_t level=1 ) const;

            virtual std::string nameFromMib( const SNMPpp::OID::ENameLookup lookup=SNMPpp::OID::kFull ) const;

            virtual std::string mibModuleName( const bool exact=false ) const;

            virtual std::string mibModuleFile( const bool exact=false ) const;

            virtual const struct tree *getTree( const bool exact=false ) const;

            virtual const struct module *getModule( const bool exact=false ) const;

        protected:

            std::vector < oid > v;
    };

    typedef std::set   <OID> SetOID;

    typedef std::vector<OID> VecOID;

    typedef std::map < SNMPpp::OID, netsnmp_variable_list *> MapOidVarList;
};


std::ostream &operator<<( std::ostream &os, const SNMPpp::OID &o );