Safir SDK Core
Loading...
Searching...
No Matches
Namespaces
Parameters.h File Reference
#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>
Include dependency graph for Parameters.h:

Go to the source code of this file.

Namespaces

namespace  Safir
 This namespace contains all the functionality and definitions of the SAFIR SDK.
 
namespace  Safir::Dob
 This namespace contains all functionality of the DOB (Components DOSE and DOTS).
 
namespace  Safir::Dob::Typesystem
 This namespace contains the DOB Typesystem functionality and definitions.
 
namespace  Safir::Dob::Typesystem::Parameters
 Functions for getting parameter information from types.
 

Functions

Information about parameters.
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetNumberOfParameters (const Dob::Typesystem::TypeId typeId)
 Get the number of parameters defined in a class.
 
DOTS_CPP_API Dob::Typesystem::ParameterIndex Safir::Dob::Typesystem::Parameters::GetIndex (const Dob::Typesystem::TypeId typeId, const std::wstring &parameterName)
 Gets index of a named parameter.
 
DOTS_CPP_API const std::wstring Safir::Dob::Typesystem::Parameters::GetName (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter)
 Get the name of the specified parameter as it was defined in the xml description.
 
DOTS_CPP_API std::wstring Safir::Dob::Typesystem::Parameters::GetTypeName (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter)
 Get the type name of the specified member as it was defined in the xml description.
 
DOTS_CPP_API MemberType Safir::Dob::Typesystem::Parameters::GetType (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter)
 Get the type of a parameter.
 
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetArraySize (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter)
 Get the array size of a parameter.
 
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetCollectionSize (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter)
 Get the number of elements in a collection parameter.
 
DOTS_CPP_API void Safir::Dob::Typesystem::Parameters::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)
 Get information about a specific parameter.
 
Parameter values.
DOTS_CPP_API bool Safir::Dob::Typesystem::Parameters::GetBoolean (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a boolean parameter value.
 
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetEnumeration (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an enumeration parameter value.
 
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetInt32 (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an Int32 parameter value.
 
DOTS_CPP_API Dob::Typesystem::Int64 Safir::Dob::Typesystem::Parameters::GetInt64 (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an Int64 parameter value.
 
DOTS_CPP_API Dob::Typesystem::Float32 Safir::Dob::Typesystem::Parameters::GetFloat32 (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a Float32 parameter value.
 
DOTS_CPP_API Dob::Typesystem::Float64 Safir::Dob::Typesystem::Parameters::GetFloat64 (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a Float64 parameter value.
 
DOTS_CPP_API const std::wstring Safir::Dob::Typesystem::Parameters::GetString (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a string parameter value.
 
DOTS_CPP_API Dob::Typesystem::TypeId Safir::Dob::Typesystem::Parameters::GetTypeId (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a TypeId parameter value.
 
DOTS_CPP_API const Dob::Typesystem::InstanceId Safir::Dob::Typesystem::Parameters::GetInstanceId (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a InstanceId parameter value.
 
DOTS_CPP_API const Dob::Typesystem::EntityId Safir::Dob::Typesystem::Parameters::GetEntityId (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an EntityId parameter value.
 
DOTS_CPP_API const Dob::Typesystem::ChannelId Safir::Dob::Typesystem::Parameters::GetChannelId (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a ChannelId parameter value.
 
DOTS_CPP_API const Dob::Typesystem::HandlerId Safir::Dob::Typesystem::Parameters::GetHandlerId (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a HandlerId parameter value.
 
DOTS_CPP_API const Dob::Typesystem::ObjectPtr Safir::Dob::Typesystem::Parameters::GetObject (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an Object parameter value.
 
DOTS_CPP_API const Dob::Typesystem::Binary Safir::Dob::Typesystem::Parameters::GetBinary (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a Binary parameter value.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::Int32 key)
 Get the index of a Int32 dictionary key.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::Int64 key)
 Get the index of a Int64 dictionary key.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const std::wstring &key)
 Get the index of a string dictionary key.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::EntityId &key)
 Get the index of a EntityId dictionary key.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::InstanceId &key)
 Get the index of a InstanceId dictionary key.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::HandlerId &key)
 Get the index of a HandlerId dictionary key.
 
DOTS_CPP_API Int32 Safir::Dob::Typesystem::Parameters::DictionaryKeyToIndex (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ChannelId &key)
 Get the index of a ChannelId dictionary key.
 
Parameter Dictionary keys.
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetEnumerationDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an enumeration parameter dictionary key.
 
DOTS_CPP_API Dob::Typesystem::Int32 Safir::Dob::Typesystem::Parameters::GetInt32DictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an Int32 parameter dictionary key.
 
DOTS_CPP_API Dob::Typesystem::Int64 Safir::Dob::Typesystem::Parameters::GetInt64DictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an Int64 parameter dictionary key.
 
DOTS_CPP_API const std::wstring Safir::Dob::Typesystem::Parameters::GetStringDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a string parameter dictionary key.
 
DOTS_CPP_API Dob::Typesystem::TypeId Safir::Dob::Typesystem::Parameters::GetTypeIdDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a TypeId parameter dictionary key.
 
DOTS_CPP_API const Dob::Typesystem::InstanceId Safir::Dob::Typesystem::Parameters::GetInstanceIdDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a InstanceId parameter dictionary key.
 
DOTS_CPP_API const Dob::Typesystem::EntityId Safir::Dob::Typesystem::Parameters::GetEntityIdDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get an EntityId parameter dictionary key.
 
DOTS_CPP_API const Dob::Typesystem::ChannelId Safir::Dob::Typesystem::Parameters::GetChannelIdDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a ChannelId parameter dictionary key.
 
DOTS_CPP_API const Dob::Typesystem::HandlerId Safir::Dob::Typesystem::Parameters::GetHandlerIdDictionaryKey (const Dob::Typesystem::TypeId typeId, const Dob::Typesystem::ParameterIndex parameter, const Dob::Typesystem::ArrayIndex index)
 Get a HandlerId parameter dictionary key.