Inscoper::SubDeviceGroupDescription¶

SubDeviceGroupDescription class provides sub-device group information. More...

#include <SubDeviceGroupDescription.h>

Public Functions¶

	Name
	SubDeviceGroupDescription() default constructor
const std::string &	getName() const Get the name of the group.
void	setName(const std::string & name) Set the name of the group.
unsigned short	getTag() const Get the tag of the group.
void	setTag(unsigned short tag) Set the tag of the group.
Inscoper::NBO::ENBOType	getNBOType() const Get the NBO type of the group.
void	setNBOType(Inscoper::NBO::ENBOType nboType) Set the NBO type of the group.
void	addSubDeviceDescription(const Inscoper::SubDeviceDescriptionPtr & subDeviceDescription) Add a description to the group.
const std::vector< Inscoper::SubDeviceDescriptionPtr > &	getSubDeviceDescriptionList() const Get the list of descriptions for this group.
void	setSubDeviceDescriptionList(const std::vector< Inscoper::SubDeviceDescriptionPtr > & subDeviceDescriptionList) Set the list of descriptions for this group.
Inscoper::SubDeviceDescriptionPtr	getSubDeviceDescription(unsigned short subDeviceTag) Get the description corresponding to the given tag.

Detailed Description¶

class Inscoper::SubDeviceGroupDescription;

SubDeviceGroupDescription class provides sub-device group information.

This class holds comprehensive information about a sub device groupe, including name, tag, NBO correspondign type, and associated sub-devices and parameters.

Public Functions Documentation¶

function SubDeviceGroupDescription¶

SubDeviceGroupDescription()

default constructor

function getName¶

const std::string & getName() const

Get the name of the group.

Return: The name of the group

Retrieves the name of the sub-device group.

function setName¶

void setName(
    const std::string & name
)

Set the name of the group.

Parameters:

name : The name of the group

Sets the name of the sub-device group.

function getTag¶

unsigned short getTag() const

Get the tag of the group.

Return: The tag of the group

Retrieves the tag of the sub-device group.

function setTag¶

void setTag(
    unsigned short tag
)

Set the tag of the group.

Parameters:

tag The tag of the group

Sets the tag of the sub-device group.

function getNBOType¶

Inscoper::NBO::ENBOType getNBOType() const

Get the NBO type of the group.

Return: The NBO type of the group

Retrieves the NBO type of the sub-device group.

function setNBOType¶

void setNBOType(
    Inscoper::NBO::ENBOType nboType
)

Set the NBO type of the group.

Parameters:

nboType The NBO type of the group

Sets the NBO type of the sub-device group.

function addSubDeviceDescription¶

void addSubDeviceDescription(
    const Inscoper::SubDeviceDescriptionPtr & subDeviceDescription
)

Add a description to the group.

Parameters:

subDeviceDescription : The description to add

Appends a sub-device description to the device's list of sub-device descriptions.

function getSubDeviceDescriptionList¶

const std::vector< Inscoper::SubDeviceDescriptionPtr > & getSubDeviceDescriptionList() const

Get the list of descriptions for this group.

Return: The list of descriptions

Retrieves the list of sub-device descriptions associated with this device.

function setSubDeviceDescriptionList¶

void setSubDeviceDescriptionList(
    const std::vector< Inscoper::SubDeviceDescriptionPtr > & subDeviceDescriptionList
)

Set the list of descriptions for this group.

Parameters:

subDeviceDescriptionList : The list of descriptions to set

Replaces the current list of sub-device descriptions with a new one.

function getSubDeviceDescription¶

Inscoper::SubDeviceDescriptionPtr getSubDeviceDescription(
    unsigned short subDeviceTag
)

Get the description corresponding to the given tag.

Parameters:

subDeviceTag : the tag

Return: : the sub-device if present, nullptr otherwise

Retrieves the sub-device description corresponding to a tag .

Updated on 2026-06-23 at 10:35:20 +0200