coreTypeOperations.hpp File Reference

#include "core-types.hpp"
#include <string>

Go to the source code of this file.

Namespaces
	helics
	the main namespace for the helics co-simulation library User functions will be in the helics namespace with internal functions possible in a lower level namespace

Functions
std::string	helics::core::to_string (core_type type)
core_type	helics::core::coreTypeFromString (std::string type) noexcept
bool	helics::core::isCoreTypeAvailable (core_type type) noexcept
bool	helics::core::matchingTypes (const std::string &type1, const std::string &type2)

Detailed Description

function definitions for operations on core types

Function Documentation

coreTypeFromString()

core_type helics::core::coreTypeFromString ( std::string  type )

noexcept

generate a core type value from a std::string

Parameters

type	a string describing the desired core type

Returns

a value of the helics_core_type enumeration helics::core_type::unrecognized if the type is not valid

isCoreTypeAvailable()

bool helics::core::isCoreTypeAvailable ( core_type  type )

noexcept

Returns true if core/broker type specified is available in current compilation.

matchingTypes()

bool helics::core::matchingTypes	(	const std::string &	type1,
		const std::string &	type2
	)

check if two data types are compatible with each other

Parameters

type1	the first type to match
type2	the second type to check

Returns

true if the types are compatible with each other

to_string()

std::string helics::core::to_string

(

core_type

type

)

generate a string based on the core type