PropertyInfo.h

Go to the documentation of this file.

/* -*- C++ -*-; c-basic-offset: 4; indent-tabs-mode: nil */
/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
 
#ifndef MODB_PROPERTYINFO_H
#define MODB_PROPERTYINFO_H
 
#include <string>
 
#include "opflex/modb/EnumInfo.h"
 
namespace opflex {
namespace modb {
 
typedef uint64_t class_id_t;
 
typedef uint64_t prop_id_t;
 
class PropertyInfo {
public:
 
    enum property_type_t {
        COMPOSITE,
        REFERENCE,
        STRING,
        S64,
        U64,
        MAC,
        ENUM8,
        ENUM16,
        ENUM32,
        ENUM64
    };
 
    enum cardinality_t {
        SCALAR,
        VECTOR
    };
 
    PropertyInfo() {}
 
    PropertyInfo(prop_id_t prop_id,
                 const std::string& property_name,
                 property_type_t type,
                 cardinality_t cardinality);
 
    PropertyInfo(prop_id_t prop_id,
                 const std::string& property_name,
                 property_type_t type,
                 cardinality_t cardinality,
                 const EnumInfo& enum_info);
 
    PropertyInfo(prop_id_t prop_id,
                 const std::string& property_name,
                 property_type_t type,
                 class_id_t class_id,
                 cardinality_t cardinality);
 
    ~PropertyInfo();
 
    prop_id_t getId() const { return prop_id; }
 
    const std::string& getName() const { return property_name; }
 
    const property_type_t getType() const { return prop_type; }
 
    const class_id_t getClassId() const { return class_id; }
 
    const cardinality_t getCardinality() const { return cardinality; }
 
    const EnumInfo& getEnumInfo() const { return enum_info; }
 
private:
    prop_id_t prop_id;
 
    std::string property_name;
 
    property_type_t prop_type;
 
    class_id_t class_id;
 
    cardinality_t cardinality;
 
    EnumInfo enum_info;
};
 
/* @} metadata */
/* @} cpp */
 
} /* namespace modb */
} /* namespace opflex */
 
#endif /* MODB_PROPERTYINFO_H */