Properties.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2006-2013 (http://safirsdkcore.com)
*
* Created by: Lars Hagström / stlrha
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core 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 Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
 
#ifndef __DOTS_PROPERTIES_H__
#define __DOTS_PROPERTIES_H__
 
#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Typesystem/Exceptions.h>
#include <Safir/Dob/Typesystem/Object.h>
#include <Safir/Dob/Typesystem/EntityId.h>
#include <Safir/Dob/Typesystem/InstanceId.h>
#include <Safir/Dob/Typesystem/ChannelId.h>
#include <Safir/Dob/Typesystem/HandlerId.h>
 
namespace Safir
{
namespace Dob
{
namespace Typesystem
{
    class DOTS_CPP_API Properties
    {
    public:
 
        static Dob::Typesystem::PropertyMappingKind GetMappingKind(const Dob::Typesystem::TypeId classId,
                                                                   const Dob::Typesystem::TypeId propertyId,
                                                                   const Dob::Typesystem::MemberIndex propertyMember);
 
        static Dob::Typesystem::Int32 GetArraySize (const Dob::Typesystem::TypeId classId,
                                                    const Dob::Typesystem::TypeId propertyId,
                                                    const Dob::Typesystem::MemberIndex propertyMember);
 
 
        static void SetNull(Dob::Typesystem::ObjectPtr object,
                            const Dob::Typesystem::TypeId propertyId,
                            const Dob::Typesystem::MemberIndex member,
                            const Dob::Typesystem::ArrayIndex index);
 
        static bool IsNull(const Dob::Typesystem::ObjectPtr object,
                           const Dob::Typesystem::TypeId propertyId,
                           const Dob::Typesystem::MemberIndex member,
                           const Dob::Typesystem::ArrayIndex index);
 
        static bool IsChanged(const Dob::Typesystem::ObjectPtr object,
                              const Dob::Typesystem::TypeId propertyId,
                              const Dob::Typesystem::MemberIndex member,
                              const Dob::Typesystem::ArrayIndex index);
 
        static bool IsReadOnly(const Dob::Typesystem::ObjectPtr object,
                               const Dob::Typesystem::TypeId propertyId,
                               const Dob::Typesystem::MemberIndex member,
                               const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const bool value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        bool & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
 
        static void SetEnum(Dob::Typesystem::ObjectPtr object,
                            const Dob::Typesystem::TypeId propertyId,
                            const Dob::Typesystem::EnumerationValue value,
                            const Dob::Typesystem::MemberIndex member,
                            const Dob::Typesystem::ArrayIndex index);
 
        static void GetEnum(const Dob::Typesystem::ObjectPtr object,
                            const Dob::Typesystem::TypeId propertyId,
                            Dob::Typesystem::EnumerationValue & value,
                            const Dob::Typesystem::MemberIndex member,
                            const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::Int32 value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::Int32 & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::Int64 value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::Int64 & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::Float32 value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::Float32 & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::Float64 value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::Float64 & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const InstanceId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        InstanceId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::EntityId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::EntityId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const ChannelId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        ChannelId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const HandlerId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        HandlerId & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const std::wstring & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        std::wstring & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::ObjectPtr ptr,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::ObjectPtr & ptr,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
        static void Set(Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        const Dob::Typesystem::Binary & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void Get(const Dob::Typesystem::ObjectPtr object,
                        const Dob::Typesystem::TypeId propertyId,
                        Dob::Typesystem::Binary & value,
                        const Dob::Typesystem::MemberIndex member,
                        const Dob::Typesystem::ArrayIndex index);
 
 
        static void GetParameterReference(const Dob::Typesystem::TypeId classId,
                                          const Dob::Typesystem::TypeId propertyId,
                                          const Dob::Typesystem::MemberIndex propertyMember,
                                          const Dob::Typesystem::ArrayIndex propertyIndex,
                                          Dob::Typesystem::TypeId& parameterTypeId,
                                          Dob::Typesystem::ParameterIndex& parameterIndex,
                                          Dob::Typesystem::ArrayIndex& parameterArrayIndex);
 
    private:
        static  void DereferenceClassMemberReference(Dob::Typesystem::Object & object,
                                                     DotsC_Int32 const * const classmemberref,
                                                     const DotsC_Int32 refSize,
                                                     const Dob::Typesystem::ArrayIndex index,
                                                     Dob::Typesystem::ContainerBase * & container, //out
                                                     bool & parentIsChanged);           //out
 
 
        static  void DereferenceClassMemberReference(const Dob::Typesystem::Object & object,
                                                     DotsC_Int32 const * const classmemberref,
                                                     const DotsC_Int32 refSize,
                                                     const Dob::Typesystem::ArrayIndex index,
                                                     Dob::Typesystem::ContainerBase const * & container, //out
                                                     bool & parentIsChanged);           //out
 
    };
}
}
}
 
#endif