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, int start=0, int stop=-1, int const step=1)
boost::json::array const &	Captures ()
Environment &	Env () const Environment of the interface handle.
boost::json::value	GetInjection (boost::json::string_view group, boost::json::string_view jp, int const nofcall) Injection at nofcall.
boost::json::value	GetInjectionArgs (boost::json::string_view jp, std::size_t const nofcall=0) Injection args subsignal at nofcall.
boost::json::value	GetInjectionArgs (std::size_t const nofcall=0) Injection args at nofcall.
boost::json::value	GetInjectionReturn (boost::json::string_view jp, std::size_t const nofcall=0) Injection return signal at nofcall.
boost::json::value	GetInjectionReturn (std::size_t const nofcall=0) Injection return signal at nofcall.
void	Inject (Expression const & e, boost::json::string_view op, boost::json::string_view group, boost::json::string_view jp="") Set injection return subsignal at nofcall.
void	InjectArgs (Expression const & e, SignalOperatorHandler const & op, boost::json::string_view jp="") Set injection args subsignal at nofcall.
void	InjectArgs (Expression const & e, boost::json::string_view jp="") Set injection args subsignal at nofcall.
void	InjectReturn (Expression const & e, SignalOperatorHandler const & op, boost::json::string_view jp="") Set injection return subsignal at nofcall.
void	InjectReturn (Expression const & e, boost::json::string_view jp="") Set injection return subsignal at nofcall.
	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
boost::json::array	ObservedArgs (int const nofcall=-1) Input arguments observed at nofcall.
std::size_t	ObservedCalls () const Number of interface calls.
boost::json::value	ObservedReturn (int const nofcall=-1) Observed return value at nofcall.
boost::json::value const &	PrototypeArgs () const
boost::json::value const &	PrototypeReturn () const
InterfaceHandle &	RunAsAction ()
InterfaceHandle &	RunAsTrigger (std::size_t const nofcall=0)
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
JsonNode	captures
JsonNode	injects

Detailed Description¶

Template parameters:

Interface

Public Functions Documentation¶

function CaptureSlice¶

boost::json::array zmbt::Environment::InterfaceHandle::CaptureSlice (
    boost::json::string_view signal_path,
    int start=0,
    int stop=-1,
    int const step=1
)

function Captures¶

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

function Env¶

Environment of the interface handle.

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

Returns:

zmbt::Environment&

function GetInjection¶

Injection at nofcall.

boost::json::value zmbt::Environment::InterfaceHandle::GetInjection (
    boost::json::string_view group,
    boost::json::string_view jp,
    int const nofcall
)

Parameters:

group return | args | exception
jp JSON pointer
nofcall number of call

function GetInjectionArgs [1/2]¶

Injection args subsignal at nofcall.

inline boost::json::value zmbt::Environment::InterfaceHandle::GetInjectionArgs (
    boost::json::string_view jp,
    std::size_t const nofcall=0
)

Parameters:

value
jp JSON Pointer
nofcall

function GetInjectionArgs [2/2]¶

Injection args at nofcall.

inline boost::json::value zmbt::Environment::InterfaceHandle::GetInjectionArgs (
    std::size_t const nofcall=0
)

Parameters:

value
nofcall

function GetInjectionReturn [1/2]¶

Injection return signal at nofcall.

inline boost::json::value zmbt::Environment::InterfaceHandle::GetInjectionReturn (
    boost::json::string_view jp,
    std::size_t const nofcall=0
)

Parameters:

jp JSON Pointer
nofcall

function GetInjectionReturn [2/2]¶

Injection return signal at nofcall.

inline boost::json::value zmbt::Environment::InterfaceHandle::GetInjectionReturn (
    std::size_t const nofcall=0
)

Parameters:

nofcall

function Inject¶

Set injection return subsignal at nofcall.

void zmbt::Environment::InterfaceHandle::Inject (
    Expression const & e,
    boost::json::string_view op,
    boost::json::string_view group,
    boost::json::string_view jp=""
)

Parameters:

e expression
op operator handler id
group return | args | exception
jp JSON Pointer

function InjectArgs [1/2]¶

Set injection args subsignal at nofcall.

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

Parameters:

e
jp JSON Pointer

function InjectArgs [2/2]¶

Set injection args subsignal at nofcall.

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

Parameters:

e
jp JSON Pointer

function InjectReturn [1/2]¶

Set injection return subsignal at nofcall.

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

Parameters:

e
jp JSON Pointer

function InjectReturn [2/2]¶

Set injection return subsignal at nofcall.

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

Parameters:

e
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 ObservedArgs¶

Input arguments observed at nofcall.

boost::json::array zmbt::Environment::InterfaceHandle::ObservedArgs (
    int const nofcall=-1
)

function ObservedCalls¶

Number of interface calls.

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

function ObservedReturn¶

Observed return value at nofcall.

boost::json::value zmbt::Environment::InterfaceHandle::ObservedReturn (
    int const nofcall=-1
)

function PrototypeArgs¶

boost::json::value const & zmbt::Environment::InterfaceHandle::PrototypeArgs () const

function PrototypeReturn¶

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

function RunAsAction¶

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

function RunAsTrigger¶

InterfaceHandle & zmbt::Environment::InterfaceHandle::RunAsTrigger (
    std::size_t const nofcall=0
)

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 captures¶

JsonNode zmbt::Environment::InterfaceHandle::captures;

variable injects¶

JsonNode zmbt::Environment::InterfaceHandle::injects;

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