PortDescriptor.hpp File Reference

Go to the source code of this file.

Namespaces
namespace	dw
namespace	dw::framework

Macros
#define	DW_DESCRIBE_PORT(TYPE_NAME, args...)   dw::framework::describePort<TYPE_NAME>(DW_PORT_TYPE_NAME_STRING_VIEW(#TYPE_NAME), ##args)
#define	DW_DESCRIBE_PORT_ARRAY(TYPE_NAME, ARRAYSIZE, args...)   dw::framework::describePortArray<TYPE_NAME, ARRAYSIZE>(DW_PORT_TYPE_NAME_STRING_VIEW(#TYPE_NAME), ##args)
#define	DW_PORT_TYPE_NAME_STRING_VIEW(TYPE_NAME_STR)   TYPE_NAME_STR##_sv

Enumerations
enum class	dw::framework::PortBinding : uint8_t {   dw::framework::OPTIONAL = 0 ,   dw::framework::REQUIRED = 1 }

Functions
template<typename Node >
constexpr auto	dw::framework::describeInputPorts ()
template<typename Node >
constexpr auto	dw::framework::describeOutputPorts ()
template<typename PortType >
constexpr auto	dw::framework::describePort (dw::core::StringView typeName, dw::core::StringView name, dw::core::StringView comment)
template<typename PortType >
constexpr auto	dw::framework::describePort (dw::core::StringView typeName, dw::core::StringView name, PortBinding binding=PortBinding::OPTIONAL, dw::core::StringView comment=""_sv)
template<typename PortType , size_t ArraySize, typename std::enable_if_t< ArraySize !=0, void > * = nullptr>
constexpr auto	dw::framework::describePortArray (dw::core::StringView typeName, dw::core::StringView name, dw::core::StringView comment)
template<typename PortType , size_t ArraySize, typename std::enable_if_t< ArraySize !=0, void > * = nullptr>
constexpr auto	dw::framework::describePortArray (dw::core::StringView typeName, dw::core::StringView name, PortBinding binding=PortBinding::OPTIONAL, dw::core::StringView comment=""_sv)
template<typename... Args>
constexpr auto	dw::framework::describePortCollection (Args &&... args)
template<typename Node , PortDirection Direction, typename std::enable_if_t< Direction==PortDirection::INPUT, void > * = nullptr>
constexpr auto	dw::framework::describePorts ()
template<typename Node , PortDirection Direction, size_t PortIndex>
constexpr size_t	dw::framework::descriptorIndex ()
template<typename Node , PortDirection Direction, size_t DescriptorIndex>
constexpr bool	dw::framework::descriptorPortArray ()
template<typename Node , PortDirection Direction, size_t DescriptorIndex>
constexpr PortBinding	dw::framework::descriptorPortBinding ()
template<typename Node , PortDirection Direction, size_t DescriptorIndex>
constexpr dw::core::StringView	dw::framework::descriptorPortComment ()
template<typename Node , PortDirection Direction, size_t DescriptorIndex>
constexpr size_t	dw::framework::descriptorPortSize ()
template<typename Node , PortDirection Direction>
constexpr bool	dw::framework::isValidPortIdentifier (StringView identifier)
template<typename Node , PortDirection Direction>
constexpr bool	dw::framework::isValidPortIndex (std::size_t portID)
template<typename Node , PortDirection Direction>
constexpr size_t	dw::framework::portArraySize (StringView identifier)
template<typename Node , PortDirection Direction>
constexpr size_t	dw::framework::portDescriptorIndex (StringView identifier)
template<typename Node , PortDirection Direction>
constexpr std::size_t	dw::framework::portDescriptorSize ()
template<typename Node , PortDirection Direction, size_t DescriptorIndex>
constexpr auto	dw::framework::portDescriptorType ()
template<typename Node , PortDirection Direction>
constexpr size_t	dw::framework::portIndex (StringView identifier)
template<typename Node , PortDirection Direction>
constexpr std::size_t	dw::framework::portSize ()
template<typename Node , PortDirection Direction, size_t PortIndex>
constexpr auto	dw::framework::portType ()

Variables
static constexpr size_t	dw::framework::PORT_ARRAY_SIZE {3U}
static constexpr size_t	dw::framework::PORT_BINDING {4U}
static constexpr size_t	dw::framework::PORT_COMMENT {5U}
static constexpr size_t	dw::framework::PORT_NAME {1U}
static constexpr size_t	dw::framework::PORT_TYPE {2U}
static constexpr size_t	dw::framework::PORT_TYPE_NAME {0U}

Macro Definition Documentation

DW_DESCRIBE_PORT

#define DW_DESCRIBE_PORT	(		TYPE_NAME,
			args...
	)		dw::framework::describePort<TYPE_NAME>(DW_PORT_TYPE_NAME_STRING_VIEW(#TYPE_NAME), ##args)

Definition at line 83 of file PortDescriptor.hpp.

DW_DESCRIBE_PORT_ARRAY

#define DW_DESCRIBE_PORT_ARRAY	(		TYPE_NAME,
			ARRAYSIZE,
			args...
	)		dw::framework::describePortArray<TYPE_NAME, ARRAYSIZE>(DW_PORT_TYPE_NAME_STRING_VIEW(#TYPE_NAME), ##args)

Definition at line 111 of file PortDescriptor.hpp.

DW_PORT_TYPE_NAME_STRING_VIEW

#define DW_PORT_TYPE_NAME_STRING_VIEW

(

TYPE_NAME_STR

)

TYPE_NAME_STR##_sv

Definition at line 82 of file PortDescriptor.hpp.