/usr/include/camp/property.hpp is in libcamp0.7-dev 0.7.1.1-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | /****************************************************************************
**
** Copyright (C) 2009-2010 TECHNOGERMA Systems France and/or its subsidiary(-ies).
** Contact: Technogerma Systems France Information (contact@technogerma.fr)
**
** This file is part of the CAMP library.
**
** CAMP is free software: you can redistribute it and/or modify
** it under the terms of the GNU Lesser General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** CAMP 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 Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public License
** along with CAMP. If not, see <http://www.gnu.org/licenses/>.
**
****************************************************************************/
#ifndef CAMP_PROPERTY_HPP
#define CAMP_PROPERTY_HPP
#include <camp/config.hpp>
#include <camp/detail/getter.hpp>
#include <camp/tagholder.hpp>
#include <camp/type.hpp>
#include <string>
namespace camp
{
template <typename T> class ClassBuilder;
class Value;
class UserObject;
class ClassVisitor;
/**
* \brief Abstract representation of a property
*
* Properties are members of metaclasses. Their main purpose is to be get and/or set;
* They also provide detailed informations about their type.
*
* \sa PSimpleroperty, ArrayProperty, EnumProperty, ObjectProperty
*/
class CAMP_API Property : public TagHolder
{
public:
/**
* \brief Destructor
*/
virtual ~Property();
/**
* \brief Get the name of the property
*
* \return Name of the property
*/
const std::string& name() const;
/**
* \brief Get the type of the property
*
* \return Type of the property
*/
Type type() const;
/**
* \brief Check if the property is currently readable for a given object
*
* \param object Object
*
* \return True if the property can be read, false otherwise
*
* \throw NullObject object is invalid
*/
bool readable(const UserObject& object) const;
/**
* \brief Check if the property is currently writable for a given object
*
* \param object Object
*
* \return True if the property can be written, false otherwise
*
* \throw NullObject object is invalid
*/
bool writable(const UserObject& object) const;
/**
* \brief Get the current value of the property for a given object
*
* \param object Object
*
* \return Value of the property
*
* \throw NullObject object is invalid
* \throw ForbiddenRead property is not readable
*/
Value get(const UserObject& object) const;
/**
* \brief Set the current value of the property for a given object
*
* \param object Object
* \param value New value to assign to the property
*
* \throw NullObject \a object is invalid
* \throw ForbiddenWrite property is not writable
* \throw BadType \a value can't be converted to the property's type
*/
void set(const UserObject& object, const Value& value) const;
/**
* \brief Accept the visitation of a ClassVisitor
*
* \param visitor Visitor to accept
*/
virtual void accept(ClassVisitor& visitor) const;
protected:
template <typename T> friend class ClassBuilder;
friend class UserObject;
/**
* \brief Construct the property from its description
*
* \param name Name of the property
* \param type Type of the property
*/
Property(const std::string& name, Type type);
/**
* \brief Do the actual reading of the value
*
* This function is a pure virtual which has to be implemented in derived classes.
*
* \param object Object
*
* \return Value of the property
*/
virtual Value getValue(const UserObject& object) const = 0;
/**
* \brief Do the actual writing of the value
*
* This function is a pure virtual which has to be implemented in derived classes.
*
* \param object Object
* \param value New value to assign to the property
*/
virtual void setValue(const UserObject& object, const Value& value) const = 0;
/**
* \brief Check if the property can be read
*
* \return True if the property can be read, false otherwise
*/
virtual bool isReadable() const;
/**
* \brief Check if the property can be written
*
* \return True if the property can be written, false otherwise
*/
virtual bool isWritable() const;
private:
std::string m_name; ///< Name of the property
Type m_type; ///< Type of the property
detail::Getter<bool> m_readable; ///< Accessor to get the readable state of the property
detail::Getter<bool> m_writable; ///< Accessor to get the writable state of the property
};
} // namespace camp
#endif // CAMP_PROPERTY_HPP
|