An Overlay-based
Virtual Network Substrate
SpoVNet

source: source/ariba/SpoVNetProperties.h @ 10700

Last change on this file since 10700 was 9684, checked in by mies, 9 years ago

almost forgot to commit: doxygen modules :)

File size: 3.2 KB
Line 
1// [License]
2// The Ariba-Underlay Copyright
3//
4// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
5//
6// Institute of Telematics
7// UniversitÀt Karlsruhe (TH)
8// Zirkel 2, 76128 Karlsruhe
9// Germany
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
22// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OF TELEMATICS OR
25// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32//
33// The views and conclusions contained in the software and documentation
34// are those of the authors and should not be interpreted as representing
35// official policies, either expressed or implied, of the Institute of
36// Telematics.
37// [License]
38
39#ifndef SPOVNETPROPERTIES_H_
40#define SPOVNETPROPERTIES_H_
41
42#include <string>
43#include <iostream>
44#include <streambuf>
45
46using std::string;
47
48namespace ariba {
49// forward declaration
50class SpoVNetProperties;
51}
52
53#include "Identifiers.h"
54#include "Name.h"
55
56namespace ariba {
57
58/**
59 * \addtogroup public
60 * @{
61 *
62 * This class implements a container that holds all properties of a
63 * SpoVNet instance. It may evolve with new features when new features
64 * are introduced.
65 *
66 * @author Sebastian Mies <mies@tm.uka.de>
67 * @author Christoph Mayer <mayer@tm.uka.de>
68 */
69class SpoVNetProperties {
70public:
71        /**
72         * Different types of overlays that are supported
73         */
74        enum OverlayType {
75                ONE_HOP_OVERLAY = 0,
76                CHORD_OVERLAY = 1,
77        };
78
79        /**
80         * This object holds the default settings for a newly created spovnet
81         * instance.
82         */
83        static const SpoVNetProperties DEFAULT;
84
85        /**
86         * Constructs a new default SpoVnet property object.
87         */
88        SpoVNetProperties();
89
90        /**
91         * Copy constructor.
92         */
93        SpoVNetProperties(const SpoVNetProperties& copy);
94
95        /**
96         * Destructor.
97         */
98        virtual ~SpoVNetProperties();
99
100        /**
101         * Returns the overlay type.
102         */
103        const OverlayType getBaseOverlayType() const;
104
105        void setBaseOverlayType( OverlayType type ) {
106                this->type = type;
107        }
108
109        /**
110         * Returns a human readable string representation of the SpoVNet properties
111         *
112         * @return A human readable string representation of the SpoVNet properties
113         */
114        std::string toString() const;
115
116private:
117        uint8_t type;
118};
119
120} // namespace ariba
121
122/** @} */
123
124#endif /* SPOVNETPROPERTIES_H_ */
Note: See TracBrowser for help on using the repository browser.