ll::PortDescriptor Class Reference

#include <PortDescriptor.h>

Public Member Functions
	PortDescriptor ()=default
	PortDescriptor (const PortDescriptor &descriptor)=default
	PortDescriptor (PortDescriptor &&descriptor)=default
	~PortDescriptor ()=default
	PortDescriptor (uint32_t binding, const std::string &name, ll::PortDirection direction, ll::PortType portType)
PortDescriptor &	operator= (const PortDescriptor &descriptor)=default
PortDescriptor &	operator= (PortDescriptor &&descriptor)=default
uint32_t	getBinding () const noexcept
const std::string &	getName () const noexcept
ll::PortDirection	getDirection () const noexcept
ll::PortType	getPortType () const noexcept
PortDescriptor &	checkImageChannelCountIs (ll::ChannelCount channelCount) noexcept
PortDescriptor &	checkImageChannelTypeIs (ll::ChannelType channelType) noexcept
PortDescriptor &	checkImageChannelTypeIsAnyOf (std::vector< ll::ChannelType > channelTypes) noexcept
PortDescriptor &	checkImageViewNormalizedCoordinatesIs (bool normalizedCoordinates) noexcept
std::pair< bool, std::string >	isValid (const std::shared_ptr< ll::Object > &port) const noexcept
	Checks whether or not a given Object is a valid port. More...

Constructor & Destructor Documentation

PortDescriptor() [1/4]

ll::PortDescriptor::PortDescriptor ( )

default

PortDescriptor() [2/4]

ll::PortDescriptor::PortDescriptor ( const PortDescriptor &  descriptor )

default

PortDescriptor() [3/4]

ll::PortDescriptor::PortDescriptor ( PortDescriptor &&  descriptor )

default

~PortDescriptor()

ll::PortDescriptor::~PortDescriptor ( )

default

PortDescriptor() [4/4]

ll::PortDescriptor::PortDescriptor	(	uint32_t	binding,
		const std::string &	name,
		ll::PortDirection	direction,
		ll::PortType	portType
	)

Member Function Documentation

checkImageChannelCountIs()

PortDescriptor& ll::PortDescriptor::checkImageChannelCountIs ( ll::ChannelCount  channelCount )

noexcept

checkImageChannelTypeIs()

PortDescriptor& ll::PortDescriptor::checkImageChannelTypeIs ( ll::ChannelType  channelType )

noexcept

checkImageChannelTypeIsAnyOf()

PortDescriptor& ll::PortDescriptor::checkImageChannelTypeIsAnyOf ( std::vector< ll::ChannelType >  channelTypes )

noexcept

checkImageViewNormalizedCoordinatesIs()

PortDescriptor& ll::PortDescriptor::checkImageViewNormalizedCoordinatesIs ( bool  normalizedCoordinates )

noexcept

getBinding()

uint32_t ll::PortDescriptor::getBinding ( ) const

noexcept

getDirection()

ll::PortDirection ll::PortDescriptor::getDirection ( ) const

noexcept

getName()

const std::string& ll::PortDescriptor::getName ( ) const

noexcept

getPortType()

ll::PortType ll::PortDescriptor::getPortType ( ) const

noexcept

isValid()

std::pair<bool, std::string> ll::PortDescriptor::isValid ( const std::shared_ptr< ll::Object > &  port ) const

noexcept

Checks whether or not a given Object is a valid port.

Parameters

port	The port to validate

Returns

(true, "") if the port is valid or (false, "some message") if the port is not valid under the spec of this descriptor.

operator=() [1/2]

PortDescriptor& ll::PortDescriptor::operator= ( const PortDescriptor &  descriptor )

default

operator=() [2/2]

PortDescriptor& ll::PortDescriptor::operator= ( PortDescriptor &&  descriptor )

default

---

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

• /root/project/lluvia/cpp/core/include/lluvia/core/node/PortDescriptor.h