mip::commands_system::InterfaceControl Struct Reference

#include <commands_system.hpp>

Classes
struct	Response

Public Member Functions
auto	asTuple () const
auto	asTuple ()
void	insert (Serializer &serializer) const
	Serialization. More...
void	extract (Serializer &serializer)

Static Public Member Functions
static InterfaceControl	create_sld_all (::mip::FunctionSelector function)

Public Attributes
FunctionSelector	function = static_cast<FunctionSelector>(0)
	Parameters. More...
CommsInterface	port = static_cast<CommsInterface>(0)
	Which physical interface is being selected (USB, serial, etc) More...
CommsProtocol	protocols_incoming
	Input protocol(s) the port will accept. If the protocol supports ACK/NACK or detailed responses, it will be sent over this port even if no corresponding output protocol is set. More...
CommsProtocol	protocols_outgoing
	Data protocol(s) the port will output. More...

Static Public Attributes
static constexpr const uint8_t	DESCRIPTOR_SET = ::mip::commands_system::DESCRIPTOR_SET
	Descriptors. More...
static constexpr const uint8_t	FIELD_DESCRIPTOR = ::mip::commands_system::CMD_INTERFACE_CONTROL
static constexpr const CompositeDescriptor	DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
static constexpr const char *	NAME = "InterfaceControl"
static constexpr const char *	DOC_NAME = "Interface Control"
static constexpr const bool	HAS_FUNCTION_SELECTOR = true

Member Function Documentation

asTuple() [1/2]

auto mip::commands_system::InterfaceControl::asTuple ( )

inline

asTuple() [2/2]

auto mip::commands_system::InterfaceControl::asTuple ( ) const

inline

create_sld_all()

static InterfaceControl mip::commands_system::InterfaceControl::create_sld_all ( ::mip::FunctionSelector  function )

inlinestatic

extract()

void mip::commands_system::InterfaceControl::extract

(

Serializer &

serializer

)

insert()

void mip::commands_system::InterfaceControl::insert

(

Serializer &

serializer

)

const

Serialization.

Member Data Documentation

DESCRIPTOR

constexpr const CompositeDescriptor mip::commands_system::InterfaceControl::DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}

staticconstexpr

DESCRIPTOR_SET

constexpr const uint8_t mip::commands_system::InterfaceControl::DESCRIPTOR_SET = ::mip::commands_system::DESCRIPTOR_SET

staticconstexpr

Descriptors.

DOC_NAME

constexpr const char* mip::commands_system::InterfaceControl::DOC_NAME = "Interface Control"

staticconstexpr

FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_system::InterfaceControl::FIELD_DESCRIPTOR = ::mip::commands_system::CMD_INTERFACE_CONTROL

staticconstexpr

function

FunctionSelector mip::commands_system::InterfaceControl::function = static_cast<FunctionSelector>(0)

Parameters.

HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_system::InterfaceControl::HAS_FUNCTION_SELECTOR = true

staticconstexpr

NAME

constexpr const char* mip::commands_system::InterfaceControl::NAME = "InterfaceControl"

staticconstexpr

port

CommsInterface mip::commands_system::InterfaceControl::port = static_cast<CommsInterface>(0)

Which physical interface is being selected (USB, serial, etc)

protocols_incoming

CommsProtocol mip::commands_system::InterfaceControl::protocols_incoming

Input protocol(s) the port will accept. If the protocol supports ACK/NACK or detailed responses, it will be sent over this port even if no corresponding output protocol is set.

protocols_outgoing

CommsProtocol mip::commands_system::InterfaceControl::protocols_outgoing

Data protocol(s) the port will output.

---

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

• src/cpp/mip/definitions/commands_system.hpp
• src/cpp/mip/definitions/commands_system.cpp