ICoreAPI< T > Class Template Reference

Generic interface returning a single value of type T from the core. More...

#include <ICoreAPI.h>

Public Member Functions
virtual	~ICoreAPI ()=default
virtual T	get ()=0
	Returns the current value exposed by this API.
virtual	~ICoreAPI ()=default
virtual T	get ()=0
	Returns the current state value.

Detailed Description

template<typename T>
class ICoreAPI< T >

Generic interface returning a single value of type T from the core.

Generic interface for querying core state values.

Implementations provide a unified way to query a core state value:

std::shared_ptr<ICoreAPI<Model>> api = std::make_shared<ModelAPI>();
Model m = api->get();

Template Parameters

T	Type of the returned value.
T	Type of the core value to access (e.g. Model).

Implementations provide a single method get() that returns the current value. It is intentionally simple to avoid tight coupling between layers.

Definition at line 30 of file ICoreAPI.h.

Constructor & Destructor Documentation

~ICoreAPI() [1/2]

template<typename T >

virtual ICoreAPI< T >::~ICoreAPI ( )

virtualdefault

~ICoreAPI() [2/2]

template<typename T >

virtual ICoreAPI< T >::~ICoreAPI ( )

virtualdefault

Member Function Documentation

get() [1/2]

template<typename T >

virtual T ICoreAPI< T >::get ( )

inlinepure virtual

Returns the current state value.

Returns

The current value of type T.

Implemented in ModelAPI, HasWilsonAPI, MartyModelNameAPI, MartyModelPathAPI, ModelAPI, SMFromHypProxy, and UseMarty.

get() [2/2]

template<typename T >

virtual T ICoreAPI< T >::get ( )

pure virtual

Returns the current value exposed by this API.

The semantics depend on the implementation: it may query a singleton-backed cache (via HyperisoMaster / MemoryManager), or return a derived property.

Returns

Current value of type T.

Implemented in ModelAPI, HasWilsonAPI, MartyModelNameAPI, MartyModelPathAPI, ModelAPI, SMFromHypProxy, and UseMarty.

---

The documentation for this class was generated from the following files:

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/PhysicalModel/ports/ICoreAPI.h
• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/ExternalIntegration/MartyInterface/ports/ICoreAPI.h