Inscoper::FunctionDescription¶

FunctionDescription class provides function information coming from drivers. More...

#include <FunctionDescription.h>

Public Functions¶

	Name
	FunctionDescription() Default constructor.
Inscoper::EFunctionType	getType() const Get the type of the function.
void	setType(Inscoper::EFunctionType type) Set the type of the function.
const std::string &	getName() const Get the name of the function.
void	setName(const std::string & name) Set the name of the function.
void	addInputParam(unsigned char pos, unsigned short tag) Add an input parameter to the function.
const std::map< unsigned short, unsigned char > &	getInputParams() const Get input parameters.
void	addOutputParam(unsigned char pos, unsigned short tag) Add an output parameter to the function.
const std::map< unsigned short, unsigned char > &	getOutputParams() const Get output parameters.
void	addConnection(unsigned short tag) Add a connection to the function.
const std::vector< unsigned short > &	getConnections() const Get the connection list.

Detailed Description¶

class Inscoper::FunctionDescription;

FunctionDescription class provides function information coming from drivers.

This class describes a single function of a sub-device, including its type, name, associated input/output parameters, and connections.

Public Functions Documentation¶

function FunctionDescription¶

FunctionDescription()

Default constructor.

Initializes a new instance of the FunctionDescription class.

function getType¶

Inscoper::EFunctionType getType() const

Get the type of the function.

Return: The type of the function

Retrieves the functional category of this function.

function setType¶

void setType(
    Inscoper::EFunctionType type
)

Set the type of the function.

Parameters:

type : The type of the function

Sets the functional category of this function.

function getName¶

const std::string & getName() const

Get the name of the function.

Return: The name of the function

Retrieves the display name of the function.

function setName¶

void setName(
    const std::string & name
)

Set the name of the function.

Parameters:

name : The name of the function

Sets the display name of the function.

function addInputParam¶

void addInputParam(
    unsigned char pos,
    unsigned short tag
)

Add an input parameter to the function.

Parameters:

pos : The position index of the parameter
tag : The unique tag of the parameter

Sets an input parameter to this function at a specific position.

function getInputParams¶

const std::map< unsigned short, unsigned char > & getInputParams() const

Get input parameters.

Return: A map pairing parameter tags with position indices

Retrieves the map of input parameters added to this function.

function addOutputParam¶

void addOutputParam(
    unsigned char pos,
    unsigned short tag
)

Add an output parameter to the function.

Parameters:

pos : The position index of the parameter
tag : The unique tag of the parameter

Sets an output parameter to this function at a specific position.

function getOutputParams¶

const std::map< unsigned short, unsigned char > & getOutputParams() const

Get output parameters.

Return: A map pairing parameter tags with position indices

Retrieves the map of output parameters added to this function.

function addConnection¶

void addConnection(
    unsigned short tag
)

Add a connection to the function.

Parameters:

tag : The connection's tag

Sets a connection tag to this function.

function getConnections¶

const std::vector< unsigned short > & getConnections() const

Get the connection list.

Return: The connection list

Retrieves the list of connection tags added to this function.

Updated on 2026-04-02 at 10:55:36 +0200