Class wrapper for handles that support the cmd interface. More...

Inheritance diagram for dqcsim::wrap::Cmd:

Public Member Functions
	Cmd (HandleIndex handle) noexcept
	Wraps the given `cmd` handle. More...

std::string	get_iface () const
	Returns the interface identifier of this command. More...

bool	is_iface (const std::string &iface) const
	Returns whether this command has the given interface identifier. More...

std::string	get_oper () const
	Returns the operation identifier of this command. More...

bool	is_oper (const std::string &oper) const
	Returns whether this command has the given operation identifier. More...

Public Member Functions inherited from dqcsim::wrap::Arb
	Arb (HandleIndex handle) noexcept
	Wraps the given `arb` handle. More...

std::string	get_arb_json_string () const
	Returns the current arbitrary JSON data as a serialized JSON string. More...

void	set_arb_json_string (const std::string &json)
	Sets the arbitrary JSON data to the given serialized JSON string. More...

std::string	get_arb_cbor_string () const
	Returns the current arbitrary JSON data as a serialized CBOR string. More...

void	set_arb_cbor_string (const std::string &cbor)
	Sets the arbitrary JSON data to the given serialized CBOR string. More...

template<class JSON >
JSON	get_arb_json () const
	Returns the current arbitrary JSON data as a JSON object from `nlohmann::json`. More...

template<class JSON >
void	set_arb_json (const JSON &json)
	Sets the arbitrary JSON data to the given JSON object from `nlohmann::json`. More...

std::string	get_arb_arg_string (ssize_t index) const
	Returns the arbitrary argument at the given index as a (binary) string. More...

template<typename T >
T	get_arb_arg_as (ssize_t index) const
	Returns the arbitrary argument at the given index as the given type. More...

template<typename T >
void	set_arb_arg_strings (const T &strings)
	Sets the arbitrary argument list to the given iterable of `std::string`s. More...

void	set_arb_arg_string (ssize_t index, const std::string &data)
	Sets the arbitrary argument at the given index to a (binary) string. More...

template<typename T >
void	set_arb_arg (ssize_t index, const T &data)
	Sets the arbitrary argument at the given index to a value of type `T`. More...

void	push_arb_arg_string (const std::string &data)
	Pushes a (binary) string to the back of the arbitrary argument list. More...

template<typename T >
void	push_arb_arg (const T &data)
	Pushes a value of type `T` to the back of the arbitrary argument list. More...

std::string	pop_arb_arg_string ()
	Pops from the back of the arbitrary argument list as a (binary) string. More...

template<typename T >
T	pop_arb_arg_as () const
	Pops from the back of the arbitrary argument list as a value of type `T`. More...

void	insert_arb_arg_string (ssize_t index, const std::string &data)
	Inserts an arbitrary argument at the given index using a (binary) string. More...

template<typename T >
void	insert_arb_arg (ssize_t index, const T &data)
	Inserts an arbitrary argument at the given index using a value of type `T`. More...

void	remove_arb_arg (ssize_t index)
	Removes the arbitrary argument at the given index. More...

size_t	get_arb_arg_count () const
	Returns the number of arbitrary arguments. More...

void	clear_arb_args ()
	Clears the arbitrary argument list. More...

void	set_arb (const Arb &src)
	Assigns all arb data from the given arb to this one. More...

Public Member Functions inherited from dqcsim::wrap::Handle
	Handle () noexcept
	Constructs an empty wrapper. More...

	Handle (HandleIndex handle) noexcept
	Wraps the given raw handle. More...

virtual	~Handle () noexcept
	Delete the handle and its wrapper.

void	free ()
	Explicitly delete the handle, allowing errors to be caught. More...

bool	is_valid () const noexcept
	Returns whether this wrapper (still) contains a valid handle. More...

HandleIndex	get_handle () const noexcept
	Returns the raw handle without relinquishing ownership. More...

HandleIndex	take_handle () noexcept
	Returns the raw handle and relinquishes ownership. More...

	Handle (const Handle &)=delete

void	operator= (const Handle &)=delete

	Handle (Handle &&src)
	Move constructor; simply moves ownership of the handle from the source object to the constructed object. More...

Handle &	operator= (Handle &&src)
	Move constructor; simply moves ownership of the handle from the source object to the assignment target. More...

std::string	dump () const
	Returns a string containing a debug dump of the handle. More...

HandleType	type () const
	Returns the type of this handle. More...

Additional Inherited Members
Protected Attributes inherited from dqcsim::wrap::Handle
HandleIndex	handle
	The wrapped handle.

Detailed Description

Class wrapper for handles that support the cmd interface.

You normally wouldn't instantiate this directly (see ArbCmd).

Definition at line 2362 of file dqcsim.

Constructor & Destructor Documentation

◆ Cmd()

dqcsim::wrap::Cmd::Cmd ( HandleIndex handle )

inlinenoexcept

Wraps the given cmd handle.

Note: This constructor does not verify that the handle is actually valid.

Parameters

handle The raw handle to wrap.

Definition at line 2373 of file dqcsim.

Member Function Documentation

◆ get_iface()

std::string dqcsim::wrap::Cmd::get_iface ( ) const

inline

Returns the interface identifier of this command.

Returns: The interface identifier of this command.

Exceptions

std::runtime_error When either handle is invalid.

Definition at line 2382 of file dqcsim.

◆ is_iface()

bool dqcsim::wrap::Cmd::is_iface ( const std::string & iface ) const

inline

Returns whether this command has the given interface identifier.

Parameters

iface The interface to match against.

Returns: Whether there was a match.

Exceptions

std::runtime_error When either handle is invalid.

Definition at line 2396 of file dqcsim.

◆ get_oper()

std::string dqcsim::wrap::Cmd::get_oper ( ) const

inline

Returns the operation identifier of this command.

Returns: The operation identifier of this command.

Exceptions

std::runtime_error When either handle is invalid.

Definition at line 2406 of file dqcsim.

◆ is_oper()

bool dqcsim::wrap::Cmd::is_oper ( const std::string & oper ) const

inline

Returns whether this command has the given operation identifier.

Parameters

oper	The operation to match against.

Returns: Whether there was a match.

Exceptions

std::runtime_error When either handle is invalid.

Definition at line 2420 of file dqcsim.

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

dqcsim

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Cmd()

Member Function Documentation

◆ get_iface()

◆ is_iface()

◆ get_oper()

◆ is_oper()