ll::ContainerNodeDescriptor Class Reference

Class for describing a container node. More...

#include <ContainerNodeDescriptor.h>

Public Member Functions
	ContainerNodeDescriptor ()=default
	ContainerNodeDescriptor (const ContainerNodeDescriptor &descriptor)=default
	ContainerNodeDescriptor (ContainerNodeDescriptor &&descriptor)=default
	~ContainerNodeDescriptor ()=default
ContainerNodeDescriptor &	operator= (const ContainerNodeDescriptor &descriptor)=default
ContainerNodeDescriptor &	operator= (ContainerNodeDescriptor &&descriptor)=default
ContainerNodeDescriptor &	addPort (const ll::PortDescriptor &port)
	Adds a port to the descriptor. More...
ContainerNodeDescriptor &	addPorts (const std::initializer_list< ll::PortDescriptor > &ports)
	Adds a list of ports to the descriptor. More...
const ll::PortDescriptor &	getPort (const std::string &name) const
	Gets a port descriptor given its name. More...
ContainerNodeDescriptor &	setParameter (const std::string &name, const ll::Parameter &value)
	Adds a parameter. More...
const ll::Parameter &	getParameter (const std::string &name) const
	Gets a parameter. More...
ContainerNodeDescriptor &	setBuilderName (const std::string &name) noexcept
	Sets the builder name this descriptor refers to within the Lua interpreter. More...
const std::string &	getBuilderName () const noexcept
	Gets the builder name within the Lua interpreter. More...

Detailed Description

Class for describing a container node.

Descriptors are used to construct ll::ContainerNode objects.

Constructor & Destructor Documentation

ContainerNodeDescriptor() [1/3]

ll::ContainerNodeDescriptor::ContainerNodeDescriptor ( )

default

ContainerNodeDescriptor() [2/3]

ll::ContainerNodeDescriptor::ContainerNodeDescriptor ( const ContainerNodeDescriptor &  descriptor )

default

ContainerNodeDescriptor() [3/3]

ll::ContainerNodeDescriptor::ContainerNodeDescriptor ( ContainerNodeDescriptor &&  descriptor )

default

~ContainerNodeDescriptor()

ll::ContainerNodeDescriptor::~ContainerNodeDescriptor ( )

default

Member Function Documentation

addPort()

ContainerNodeDescriptor& ll::ContainerNodeDescriptor::addPort

(

const ll::PortDescriptor &

port

)

Adds a port to the descriptor.

Parameters

[in]

port

The port

Returns

A reference to this object.

addPorts()

ContainerNodeDescriptor& ll::ContainerNodeDescriptor::addPorts

(

const std::initializer_list< ll::PortDescriptor > &

ports

)

Adds a list of ports to the descriptor.

Parameters

[in]

ports

The ports

Returns

A reference to this object.

getBuilderName()

const std::string& ll::ContainerNodeDescriptor::getBuilderName ( ) const

noexcept

Gets the builder name within the Lua interpreter.

Returns

The builder name.

getParameter()

const ll::Parameter& ll::ContainerNodeDescriptor::getParameter

(

const std::string &

name

)

const

Gets a parameter.

Parameters

[in]

name

The parameter name

Returns

The parameter.

Exceptions

std::system_error

With error code ll::ErrorCode::KeyNotFound if name is not in the parameters table.

getPort()

const ll::PortDescriptor& ll::ContainerNodeDescriptor::getPort

(

const std::string &

name

)

const

Gets a port descriptor given its name.

Parameters

[in]

name

The name

Returns

The port descriptor.

Exceptions

std::system_error

With error code ll::ErrorCode::KeyNotFound if name is not in the ports table.

operator=() [1/2]

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

default

operator=() [2/2]

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

default

setBuilderName()

ContainerNodeDescriptor& ll::ContainerNodeDescriptor::setBuilderName ( const std::string &  name )

noexcept

Sets the builder name this descriptor refers to within the Lua interpreter.

Parameters

[in]

name

The builder name.

Returns

A reference to this object.

setParameter()

ContainerNodeDescriptor& ll::ContainerNodeDescriptor::setParameter	(	const std::string &	name,
		const ll::Parameter &	value
	)

Adds a parameter.

Parameters

[in]	name	The name
[in]	defaultValue	The value.

Returns

A reference to this object.

---

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

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