Class zmbt::Environment::InterfaceHandle

ClassList > zmbt > Environment > InterfaceHandle

Environment extension handling the interface data.More...

• #include <environment_interface_record.hpp>

Inherited by the following classes: zmbt::Environment::TypedInterfaceHandle

Public Functions

Type	Name
boost::json::array	CaptureSlice (boost::json::string_view signal_path) const
boost::json::array const &	Captures () const
void	EnableOutputRecordFor (ChannelKind const kind)
Environment &	Env () const Environment of the interface handle.
void	Inject (std::shared_ptr< Generator > gen, lang::Expression const & tf, ChannelKind const kind, boost::json::string_view jp="") Set generating function for injection.
void	InjectArgs (lang::Expression const & e, boost::json::string_view jp="") Set generating function for injection args.
void	InjectReturn (lang::Expression const & e, boost::json::string_view jp="") Set generating function for injection return.
	InterfaceHandle (Environment const & e, interface_id const & interface, object_id refobj)
	InterfaceHandle (Environment const & e, boost::json::string_view ref)
	InterfaceHandle (interface_id const & interface, object_id refobj)
	InterfaceHandle (interface_id const & interface, nullptr_t)
	InterfaceHandle (boost::json::string_view ref)
	InterfaceHandle (interface_id const & interface, H const & obj)
	InterfaceHandle (InterfaceHandle const &) = default
	InterfaceHandle (InterfaceHandle && o) = default
void	MaybeThrowException () throw exception if set for current call
std::size_t	ObservedCalls () const Number of interface calls.
boost::json::array	PrototypeArgs () const
boost::json::value	PrototypeReturn () const
InterfaceHandle &	RunAsAction ()
InterfaceHandle &	RunAsTrigger (std::size_t const repeats=1)
boost::json::value	YieldInjection (ChannelKind const kind) Yield input generator.
boost::json::value	YieldInjectionArgs () Injection at nofcall.
boost::json::value	YieldInjectionReturn ()
interface_id	interface () const
boost::json::string const &	key () const
InterfaceHandle &	operator= (InterfaceHandle const &) = default
InterfaceHandle &	operator= (InterfaceHandle &&) = default
object_id	refobj () const
	~InterfaceHandle () = default

Protected Attributes

Type	Name
zmbt::Environment	env
std::shared_ptr< OutputRecorder >	output_recorder_

Detailed Description

Template parameters:

• Interface

Public Functions Documentation

function CaptureSlice

boost::json::array zmbt::Environment::InterfaceHandle::CaptureSlice (
    boost::json::string_view signal_path
) const

---

function Captures

boost::json::array const & zmbt::Environment::InterfaceHandle::Captures () const

---

function EnableOutputRecordFor

void zmbt::Environment::InterfaceHandle::EnableOutputRecordFor (
    ChannelKind const kind
) 

---

function Env

Environment of the interface handle.

inline Environment & zmbt::Environment::InterfaceHandle::Env () const

Returns:

zmbt::Environment&

---

function Inject

Set generating function for injection.

void zmbt::Environment::InterfaceHandle::Inject (
    std::shared_ptr< Generator > gen,
    lang::Expression const & tf,
    ChannelKind const kind,
    boost::json::string_view jp=""
) 

Parameters:

• e input generator
• group return | args | exception
• jp JSON Pointer

---

function InjectArgs

Set generating function for injection args.

inline void zmbt::Environment::InterfaceHandle::InjectArgs (
    lang::Expression const & e,
    boost::json::string_view jp=""
) 

The intput conditions are evaluated from the corresponding expressions with 0-based call index as an argument.

Parameters:

• e
• jp JSON Pointer

---

function InjectReturn

Set generating function for injection return.

inline void zmbt::Environment::InterfaceHandle::InjectReturn (
    lang::Expression const & e,
    boost::json::string_view jp=""
) 

The intput conditions are evaluated from the corresponding expressions with 0-based call index as an argument.

Parameters:

• e generating funcion expression
• jp JSON Pointer

---

function InterfaceHandle [1/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    Environment const & e,
    interface_id const & interface,
    object_id refobj
) 

---

function InterfaceHandle [2/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    Environment const & e,
    boost::json::string_view ref
) 

---

function InterfaceHandle [3/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    interface_id const & interface,
    object_id refobj
) 

---

function InterfaceHandle [4/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    interface_id const & interface,
    nullptr_t
) 

---

function InterfaceHandle [5/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    boost::json::string_view ref
) 

---

function InterfaceHandle [6/8]

template<class H, class E>
inline zmbt::Environment::InterfaceHandle::InterfaceHandle (
    interface_id const & interface,
    H const & obj
) 

---

function InterfaceHandle [7/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    InterfaceHandle const &
) = default

---

function InterfaceHandle [8/8]

zmbt::Environment::InterfaceHandle::InterfaceHandle (
    InterfaceHandle && o
) = default

---

function MaybeThrowException

throw exception if set for current call

void zmbt::Environment::InterfaceHandle::MaybeThrowException () 

---

function ObservedCalls

Number of interface calls.

std::size_t zmbt::Environment::InterfaceHandle::ObservedCalls () const

---

function PrototypeArgs

boost::json::array zmbt::Environment::InterfaceHandle::PrototypeArgs () const

---

function PrototypeReturn

boost::json::value zmbt::Environment::InterfaceHandle::PrototypeReturn () const

---

function RunAsAction

InterfaceHandle & zmbt::Environment::InterfaceHandle::RunAsAction () 

---

function RunAsTrigger

InterfaceHandle & zmbt::Environment::InterfaceHandle::RunAsTrigger (
    std::size_t const repeats=1
) 

---

function YieldInjection

Yield input generator.

boost::json::value zmbt::Environment::InterfaceHandle::YieldInjection (
    ChannelKind const kind
) 

---

function YieldInjectionArgs

Injection at nofcall.

inline boost::json::value zmbt::Environment::InterfaceHandle::YieldInjectionArgs () 

---

function YieldInjectionReturn

inline boost::json::value zmbt::Environment::InterfaceHandle::YieldInjectionReturn () 

---

function interface

inline interface_id zmbt::Environment::InterfaceHandle::interface () const

---

function key

boost::json::string const & zmbt::Environment::InterfaceHandle::key () const

---

function operator=

InterfaceHandle & zmbt::Environment::InterfaceHandle::operator= (
    InterfaceHandle const &
) = default

---

function operator=

InterfaceHandle & zmbt::Environment::InterfaceHandle::operator= (
    InterfaceHandle &&
) = default

---

function refobj

inline object_id zmbt::Environment::InterfaceHandle::refobj () const

---

function ~InterfaceHandle

zmbt::Environment::InterfaceHandle::~InterfaceHandle () = default

---

Protected Attributes Documentation

variable env

zmbt::Environment zmbt::Environment::InterfaceHandle::env;

---

variable output_recorder_

std::shared_ptr<OutputRecorder> zmbt::Environment::InterfaceHandle::output_recorder_;

---

---

The documentation for this class was generated from the following file zmbt-framework/zmbt-framework/backends/cxx/include/zmbt/model/environment_interface_record.hpp