IMapperView Struct Reference

Minimal runtime-polymorphic view over a mapper. More...

#include <mapper_hub.hpp>

Inheritance diagram for IMapperView:

Public Member Functions
virtual	~IMapperView ()=default
virtual std::string	canonical (std::string_view s) const =0
	Resolve a name or alias to its canonical string.
virtual std::vector< std::string >	list_all () const =0
	List all known canonical strings.
virtual bool	register_custom (std::string canonical, std::vector< std::string > aliases)=0
	Generic custom registration hook.

Detailed Description

Minimal runtime-polymorphic view over a mapper.

Definition at line 58 of file mapper_hub.hpp.

Constructor & Destructor Documentation

~IMapperView()

virtual IMapperView::~IMapperView ( )

virtualdefault

Member Function Documentation

canonical()

virtual std::string IMapperView::canonical ( std::string_view  s ) const

pure virtual

Resolve a name or alias to its canonical string.

Parameters

s	Input name or alias.

Returns

Canonical string stored by the mapper.

Implemented in MapperViewSimple< Concrete >, and MapperViewReadOnly< Concrete >.

list_all()

virtual std::vector< std::string > IMapperView::list_all ( ) const

pure virtual

List all known canonical strings.

Returns

Builtin and custom canonical strings known to the mapper.

Implemented in MapperViewSimple< Concrete >, and MapperViewReadOnly< Concrete >.

register_custom()

virtual bool IMapperView::register_custom ( std::string  canonical, std::vector< std::string >  aliases  )

pure virtual

Generic custom registration hook.

This is supported only for mappers whose custom symbols need no additional semantic information. For observables and decays, use the dedicated helper functions below so invariants are preserved.

Parameters

canonical	Canonical name.
aliases	Aliases.

Returns

true on success, false if unsupported or rejected.

Implemented in MapperViewSimple< Concrete >, and MapperViewReadOnly< Concrete >.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Common/Mapper/mapper_hub.hpp