Parameter.h

/* 
 *  Copyright 2011 Matthias Fuchs
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

#ifndef STROMX_RUNTIME_PARAMETER_H
#define STROMX_RUNTIME_PARAMETER_H

#include "stromx/runtime/DescriptionBase.h"

namespace stromx
{
    namespace runtime
    {
        class ParameterGroup;
        
        class STROMX_RUNTIME_API Parameter : public DescriptionBase
        {
        public:
            enum AccessMode
            {
                NO_ACCESS,
                NONE_READ,
                NONE_WRITE,
                INITIALIZED_READ,
                INITIALIZED_WRITE,
                ACTIVATED_WRITE
            };
            
            enum UpdateBehavior
            {
                PERSISTENT,
                PUSH,
                PULL,
                INTERNAL
            };
            
            Parameter(const unsigned int id, const VariantHandle& variant, ParameterGroup* const group = 0);
            
            AccessMode accessMode() const { return m_access; }
            
            void setAccessMode(const AccessMode mode) { m_access = mode; }
            
            UpdateBehavior updateBehavior() const { return m_behavior; }
            
            void setUpdateBehavior(const UpdateBehavior behavior) { m_behavior = behavior; }
            
            virtual const Parameter* group() const { return m_group; }
            
            virtual const std::vector<const Parameter*> & members() const { return NO_MEMBERS; }
            
        private:
            static const std::vector<const Parameter*> NO_MEMBERS;
            
            AccessMode m_access;
            UpdateBehavior m_behavior;
            const Parameter* m_group;
        };
    }
}

#endif // STROMX_RUNTIME_PARAMETER_H