Inscoper::DiagResults¶

DiagResults class contains the results from a device diagnostic. More...

#include <DiagResults.h>

Public Functions¶

	Name
	DiagResults() Default constructor.
	~DiagResults() Default destructor.
void	setSubDeviceStatus(const std::map< unsigned short, Inscoper::ESubDeviceStatus > & statusMap) Set sub-device statuses.
Inscoper::ESubDeviceStatus	getSubDeviceStatus(unsigned short subDeviceTag) Get sub-device status.
Inscoper::EFunctionStatus	getFunctionStatus(unsigned short subDeviceTag, Inscoper::EFunctionType functionType) Get function status.
Inscoper::ConstraintPtr	getParamConstraint(unsigned short paramTag) Get parameter constraint.
std::map< unsigned short, Inscoper::ESubDeviceStatus >	getSubDeviceStatusMap() Get all sub-device statuses.
std::map< unsigned short, Inscoper::ConstraintPtr >	getParamConstraintMap() Get all parameter constraints.
void	addParamConstraint(unsigned short paramTag, const Inscoper::ConstraintPtr & constraint) Add parameter constraint.
void	addFunctionStatus(unsigned short subDeviceTag, Inscoper::EFunctionType functionType, Inscoper::EFunctionStatus functionStatus) Add function status.
const std::string &	getName() const Get name.
void	setName(const std::string & name) Set name.
const Inscoper::DriverConfigPtr &	getDriverConfig() const Get driver configuration.
void	setDriverConfig(const Inscoper::DriverConfigPtr & driverConfig) Set driver configuration.

Detailed Description¶

class Inscoper::DiagResults;

DiagResults class contains the results from a device diagnostic.

Aggregates status information and constraints for sub-devices of a device and their functions, providing a comprehensive report of the system's state.

Public Functions Documentation¶

function DiagResults¶

DiagResults()

Default constructor.

Initializes a new instance of the DiagResults class.

function ~DiagResults¶

~DiagResults()

Default destructor.

function setSubDeviceStatus¶

void setSubDeviceStatus(
    const std::map< unsigned short, Inscoper::ESubDeviceStatus > & statusMap
)

Set sub-device statuses.

Parameters:

statusMap : A map associating sub-device tags with their status

Populates the map of sub-device statuses.

function getSubDeviceStatus¶

Inscoper::ESubDeviceStatus getSubDeviceStatus(
    unsigned short subDeviceTag
)

Get sub-device status.

Parameters:

subDeviceTag : The tag of the sub-device

Return: The status of the sub-device

Retrieves the status of a specific sub-device.

function getFunctionStatus¶

Inscoper::EFunctionStatus getFunctionStatus(
    unsigned short subDeviceTag,
    Inscoper::EFunctionType functionType
)

Get function status.

Parameters:

subDeviceTag : The tag of the sub-device
functionType : The type of function to query

Return: The status of the function

Retrieves the status of a specific function on a sub-device.

function getParamConstraint¶

Inscoper::ConstraintPtr getParamConstraint(
    unsigned short paramTag
)

Get parameter constraint.

Parameters:

paramTag : The tag of the parameter

Return: A shared pointer to the constraint object

Retrieves the constraint object associated with a specific parameter.

function getSubDeviceStatusMap¶

std::map< unsigned short, Inscoper::ESubDeviceStatus > getSubDeviceStatusMap()

Get all sub-device statuses.

Return: A map of sub-device tags to statuses

Retrieves the complete map of sub-device statuses.

function getParamConstraintMap¶

std::map< unsigned short, Inscoper::ConstraintPtr > getParamConstraintMap()

Get all parameter constraints.

Return: A map of parameter tags to constraints

Retrieves the complete map of parameter constraints.

function addParamConstraint¶

void addParamConstraint(
    unsigned short paramTag,
    const Inscoper::ConstraintPtr & constraint
)

Add parameter constraint.

Parameters:

paramTag : The tag of the parameter
constraint : The constraint object to add

Adds or updates a constraint for a specific parameter.

function addFunctionStatus¶

void addFunctionStatus(
    unsigned short subDeviceTag,
    Inscoper::EFunctionType functionType,
    Inscoper::EFunctionStatus functionStatus
)

Add function status.

Parameters:

subDeviceTag : The tag of the sub-device
functionType : The type of function
functionStatus : The status to add

Adds the status of a specific function on a sub-device.

function getName¶

const std::string & getName() const

Get name.

Return: The name

Retrieves the name associated with this diagnostic result.

function setName¶

void setName(
    const std::string & name
)

Set name.

Parameters:

name : The name

Sets the name associated with this diagnostic result.

function getDriverConfig¶

const Inscoper::DriverConfigPtr & getDriverConfig() const

Get driver configuration.

Return: A shared pointer to the DriverConfig

Retrieves the driver configuration associated with the diagnostic.

function setDriverConfig¶

void setDriverConfig(
    const Inscoper::DriverConfigPtr & driverConfig
)

Set driver configuration.

Parameters:

driverConfig : The new DriverConfig pointer

Sets the driver configuration associated with the diagnosis.

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