CompositionType.hpp

Go to the documentation of this file.

// Torc - Copyright 2011-2013 University of Southern California.  All Rights Reserved.
// $HeadURL$
// $Id$

// This program is free software: you can redistribute it and/or modify it under the terms of the 
// GNU General Public License as published by the Free Software Foundation, either version 3 of the 
// License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 
// the GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.  If 
// not, see <http://www.gnu.org/licenses/>.

#ifndef TORC_GENERIC_COMPOSITIONTYPE_HPP
#define TORC_GENERIC_COMPOSITIONTYPE_HPP

/**
 * @file CompositionType.hpp
 * @brief Contains definition for CompositionType
 * 
 * This file contains the contains the definition for CompositionType
 */
namespace torc {
namespace generic {

/**
 * @enum CompositionType
 * @brief Defines possible Composition types
 * 
 * Used in composite objects, this type indicates whether an object is a Scalar, a Vector, a bit of
 * a vector (VectorBit) or a Bundle
 */
enum CompositionType {
    eCompositionTypeScalar, eCompositionTypeVector, eCompositionTypeVectorBit,
    eCompositionTypeBundle

};

} // namespace generic
} // namespace torc
#endif // TORC_GENERIC_COMPOSITIONTYPE_HPP