Parameters.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2006-2013, 2024 (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_PARAMETERS_H__
#define __DOTS_PARAMETERS_H__
 
#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Typesystem/Exceptions.h>
#include <Safir/Dob/Typesystem/EntityId.h>
#include <Safir/Dob/Typesystem/ChannelId.h>
#include <Safir/Dob/Typesystem/HandlerId.h>
#include <Safir/Dob/Typesystem/Object.h>
 
namespace Safir
{
namespace Dob
{
namespace Typesystem
{
namespace Parameters
{
    DOTS_CPP_API Dob::Typesystem::Int32 GetNumberOfParameters(const Dob::Typesystem::TypeId typeId);
 
    DOTS_CPP_API Dob::Typesystem::ParameterIndex GetIndex(const Dob::Typesystem::TypeId typeId,
                                                          const std::wstring& parameterName);
 
    DOTS_CPP_API const std::wstring GetName(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter);
 
    DOTS_CPP_API std::wstring GetTypeName(const Dob::Typesystem::TypeId typeId,
                                          const Dob::Typesystem::ParameterIndex parameter);
 
    DOTS_CPP_API MemberType GetType(const Dob::Typesystem::TypeId typeId,
                                    const Dob::Typesystem::ParameterIndex parameter);
 
    DOTS_CPP_API Dob::Typesystem::Int32 GetArraySize(const Dob::Typesystem::TypeId typeId,
                                                     const Dob::Typesystem::ParameterIndex parameter);
 
    DOTS_CPP_API Dob::Typesystem::Int32 GetCollectionSize(const Dob::Typesystem::TypeId typeId,
                                                          const Dob::Typesystem::ParameterIndex parameter);
 
    DOTS_CPP_API void GetInfo(const Dob::Typesystem::TypeId typeId,
                              const Dob::Typesystem::ParameterIndex parameter,
                              Dob::Typesystem::MemberType& parameterType,
                              Dob::Typesystem::MemberType& keyType,
                              std::wstring& parameterName,
                              Dob::Typesystem::TypeId& parameterTypeId,
                              Dob::Typesystem::TypeId& keyTypeId,
                              Dob::Typesystem::CollectionType & collectionType,
                              Dob::Typesystem::Int32& numberOfValues);
 
    DOTS_CPP_API bool GetBoolean(const Dob::Typesystem::TypeId typeId,
                                 const Dob::Typesystem::ParameterIndex parameter,
                                 const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Int32 GetEnumeration(const Dob::Typesystem::TypeId typeId,
                                                       const Dob::Typesystem::ParameterIndex parameter,
                                                       const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Int32 GetInt32(const Dob::Typesystem::TypeId typeId,
                                                 const Dob::Typesystem::ParameterIndex parameter,
                                                 const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Int64 GetInt64(const Dob::Typesystem::TypeId typeId,
                                                 const Dob::Typesystem::ParameterIndex parameter,
                                                 const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Float32 GetFloat32(const Dob::Typesystem::TypeId typeId,
                                                     const Dob::Typesystem::ParameterIndex parameter,
                                                     const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Float64 GetFloat64(const Dob::Typesystem::TypeId typeId,
                                                     const Dob::Typesystem::ParameterIndex parameter,
                                                     const Dob::Typesystem::ArrayIndex index);
    DOTS_CPP_API const std::wstring GetString(const Dob::Typesystem::TypeId typeId,
                                              const Dob::Typesystem::ParameterIndex parameter,
                                              const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::TypeId GetTypeId(const Dob::Typesystem::TypeId typeId,
                                                   const Dob::Typesystem::ParameterIndex parameter,
                                                   const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::InstanceId GetInstanceId(const Dob::Typesystem::TypeId typeId,
                                                                 const Dob::Typesystem::ParameterIndex parameter,
                                                                 const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::EntityId GetEntityId(const Dob::Typesystem::TypeId typeId,
                                                             const Dob::Typesystem::ParameterIndex parameter,
                                                             const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::ChannelId GetChannelId(const Dob::Typesystem::TypeId typeId,
                                                               const Dob::Typesystem::ParameterIndex parameter,
                                                               const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::HandlerId GetHandlerId(const Dob::Typesystem::TypeId typeId,
                                                               const Dob::Typesystem::ParameterIndex parameter,
                                                               const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::ObjectPtr GetObject(const Dob::Typesystem::TypeId typeId,
                                                            const Dob::Typesystem::ParameterIndex parameter,
                                                            const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::Binary GetBinary(const Dob::Typesystem::TypeId typeId,
                                                         const Dob::Typesystem::ParameterIndex parameter,
                                                         const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const Dob::Typesystem::Int32 key);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const Dob::Typesystem::Int64 key);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const std::wstring& key);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const Dob::Typesystem::EntityId& key);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const Dob::Typesystem::InstanceId& key);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const Dob::Typesystem::HandlerId& key);
 
    DOTS_CPP_API Int32 DictionaryKeyToIndex(const Dob::Typesystem::TypeId typeId,
                                            const Dob::Typesystem::ParameterIndex parameter,
                                            const Dob::Typesystem::ChannelId& key);
 
 
    DOTS_CPP_API Dob::Typesystem::Int32 GetEnumerationDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                                    const Dob::Typesystem::ParameterIndex parameter,
                                                                    const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Int32 GetInt32DictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                              const Dob::Typesystem::ParameterIndex parameter,
                                                              const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::Int64 GetInt64DictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                              const Dob::Typesystem::ParameterIndex parameter,
                                                              const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const std::wstring GetStringDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                           const Dob::Typesystem::ParameterIndex parameter,
                                                           const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API Dob::Typesystem::TypeId GetTypeIdDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                                const Dob::Typesystem::ParameterIndex parameter,
                                                                const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::InstanceId GetInstanceIdDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                                              const Dob::Typesystem::ParameterIndex parameter,
                                                                              const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::EntityId GetEntityIdDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                                          const Dob::Typesystem::ParameterIndex parameter,
                                                                          const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::ChannelId GetChannelIdDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                                            const Dob::Typesystem::ParameterIndex parameter,
                                                                            const Dob::Typesystem::ArrayIndex index);
 
    DOTS_CPP_API const Dob::Typesystem::HandlerId GetHandlerIdDictionaryKey(const Dob::Typesystem::TypeId typeId,
                                                                            const Dob::Typesystem::ParameterIndex parameter,
                                                                            const Dob::Typesystem::ArrayIndex index);
}
}
}
}
 
#endif