The SheetModelDataFlowFactory class. It contains the methods to create, update and add rows to the Data Flow's sheet model. More...

#include <SheetModelDataFlowFactory.hpp>

Inheritance diagram for iv::gui::factory::SheetModelDataFlowFactory:

[legend]

Collaboration diagram for iv::gui::factory::SheetModelDataFlowFactory:

[legend]

Static Public Member Functions
static std::shared_ptr< AbstractSheetModel >	createSheetModelDataFlow (const std::shared_ptr< iv::types::networkId > &selectedNetworkId, const std::shared_ptr< iv::eLanguage > &language)
	Factory method to create a SheetModelDataFlow object.

static void	updateSheetModelDataFlow (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::types::networkId &networkId)
	Updates the SheetModelDataFlow object with the new data.

static void	addRowToSheetModelDataFlow (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::RowId &rowId, const iv::types::networkId &networkId)
	Adds a row to the SheetModelDataFlow object.

static std::string	getSheetModelDataFlowColumnName (iv::gui::sheets::ColumnId columnId, iv::comms::eProtocolType protocolType)
	Gets the column name for the SheetModelDataFlow object.

static std::string	getSheetModelDataFlowParameterName (iv::gui::sheets::ColumnId columnId, iv::comms::eProtocolType protocolType, bool shortName)
	Gets the parameter name for the SheetModelDataFlow object.

static uint16_t	getSheetModelDataFlowColumnWidth (iv::gui::sheets::ColumnId columnId, iv::comms::eProtocolType protocolType)
	Gets the column width for the SheetModelDataFlow object.

static void	addColumnDefinitionToSheetModel (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::ColumnId &columnId, uint32_t columnPosition, const std::string &columnTitle, const std::string &columnTooltip, uint16_t columnWidth, bool isVisible)

static void	removeColumnDefinitionFromSheetModel (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::ColumnId &columnId)

static void	addCommonCellDefinitionListeners (iv::gui::sheets::CellDefinition &cellDefinition)

static void	addRowDefinitionToSheetModel (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::RowId &rowId, uint32_t rowPosition, bool isVisible)

static bool	findLowerBoundRow (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::RowId &rowIdReference, iv::gui::sheets::RowId *resultRowId)

static void	removeRow (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::RowId &rowId)

static void	updateRowTitles (const std::shared_ptr< AbstractSheetModel > &sheetModel)

static bool	findLowerBoundRowCheckingInAscendingPositionOrder (const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::RowId &rowIdReference, iv::gui::sheets::RowId *resultRowId)

static std::shared_ptr< AbstractSheetModel >	createCSheetModelTankCalibrationTable (const std::shared_ptr< iv::tanks::TankCalibrationData > &calibrationDataRef, double *selectedTrim)

static void	updateCSheetModelTankCalibrationTable (const std::shared_ptr< AbstractSheetModel > &sheetModel, const std::shared_ptr< iv::tanks::TrimCalibrationData > &calibrationDataRef)

static void	addRowToCSheetModelTankCalibrationTable (const std::shared_ptr< iv::tanks::TrimCalibrationData > &calibrationDataRef, const std::shared_ptr< AbstractSheetModel > &sheetModel, const iv::gui::sheets::RowId &rowId)

static std::string	getCSheetModelTankCalibrationTableColumnName (iv::gui::sheets::ColumnId columnId, bool shortName=true)

static iv::gui::sheets::CellDefinition	prvCreateButtonCellDefinition (const std::string &text)

Static Public Attributes
static const int32_t	kDefaultLanguageColumnPosition = 9

static const int32_t	kNoId = 0

Detailed Description

The SheetModelDataFlowFactory class. It contains the methods to create, update and add rows to the Data Flow's sheet model.

Member Function Documentation

◆ addColumnDefinitionToSheetModel()

void CSheetModelFactory::addColumnDefinitionToSheetModel	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::ColumnId &	columnId,
		uint32_t	columnPosition,
		const std::string &	columnTitle,
		const std::string &	columnTooltip,
		uint16_t	columnWidth,
		bool	isVisible )

staticinherited

◆ addCommonCellDefinitionListeners()

void CSheetModelFactory::addCommonCellDefinitionListeners ( iv::gui::sheets::CellDefinition & cellDefinition )

staticinherited

◆ addRowDefinitionToSheetModel()

void CSheetModelFactory::addRowDefinitionToSheetModel	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::RowId &	rowId,
		uint32_t	rowPosition,
		bool	isVisible )

staticinherited

◆ addRowToCSheetModelTankCalibrationTable()

void CSheetModelFactory::addRowToCSheetModelTankCalibrationTable	(	const std::shared_ptr< iv::tanks::TrimCalibrationData > &	calibrationDataRef,
		const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::RowId &	rowId )

staticinherited

◆ addRowToSheetModelDataFlow()

void iv::gui::factory::SheetModelDataFlowFactory::addRowToSheetModelDataFlow	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::RowId &	rowId,
		const iv::types::networkId &	networkId )

static

Adds a row to the SheetModelDataFlow object.

Parameters

sheetModel	The reference to the SheetModelDataFlow object to add the row.
rowId	The row ID to add to the SheetModelDataFlow object.
networkId	The network ID to add the row to the SheetModelDataFlow object.

◆ createCSheetModelTankCalibrationTable()

std::shared_ptr< AbstractSheetModel > CSheetModelFactory::createCSheetModelTankCalibrationTable	(	const std::shared_ptr< iv::tanks::TankCalibrationData > &	calibrationDataRef,
		double *	selectedTrim )

staticinherited

◆ createSheetModelDataFlow()

std::shared_ptr< AbstractSheetModel > iv::gui::factory::SheetModelDataFlowFactory::createSheetModelDataFlow	(	const std::shared_ptr< iv::types::networkId > &	selectedNetworkId,
		const std::shared_ptr< iv::eLanguage > &	selectedLanguage )

static

Factory method to create a SheetModelDataFlow object.

Parameters

selectedNetworkId The reference to the network ID that will indicate each cell which one is displaying.

Returns: A shared pointer to the created SheetModelDataFlow object.

◆ findLowerBoundRow()

bool CSheetModelFactory::findLowerBoundRow	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::RowId &	rowIdReference,
		iv::gui::sheets::RowId *	resultRowId )

staticinherited

Finds the first row that is not considered to go before rowIdReference (i.e., either it is equivalent or goes after).

Parameters

[in]	sheetModel	AbstractSheetModel to work with
[in]	rowIdReference	Row (unitId, channelId) as a reference in the search. #param[out] resultRowId First row that is not considered to go before rowIdReference.

◆ findLowerBoundRowCheckingInAscendingPositionOrder()

bool CSheetModelFactory::findLowerBoundRowCheckingInAscendingPositionOrder	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::RowId &	rowIdReference,
		iv::gui::sheets::RowId *	resultRowId )

staticinherited

◆ getCSheetModelTankCalibrationTableColumnName()

std::string CSheetModelFactory::getCSheetModelTankCalibrationTableColumnName	(	iv::gui::sheets::ColumnId	columnId,
		bool	shortName = true )

staticinherited

◆ getSheetModelDataFlowColumnName()

std::string iv::gui::factory::SheetModelDataFlowFactory::getSheetModelDataFlowColumnName	(	iv::gui::sheets::ColumnId	columnId,
		iv::comms::eProtocolType	protocolType )

static

Gets the column name for the SheetModelDataFlow object.

Parameters

columnId	The column ID to get the name.
protocolType	The protocol type to get the column name.

Returns: The column name for the SheetModelDataFlow object.

◆ getSheetModelDataFlowColumnWidth()

uint16_t iv::gui::factory::SheetModelDataFlowFactory::getSheetModelDataFlowColumnWidth	(	iv::gui::sheets::ColumnId	columnId,
		iv::comms::eProtocolType	protocolType )

static

Gets the column width for the SheetModelDataFlow object.

Parameters

columnId	The column ID to get the column width.
protocolType	The protocol type to get the column width.

Returns: The column width for the SheetModelDataFlow object.

◆ getSheetModelDataFlowParameterName()

std::string iv::gui::factory::SheetModelDataFlowFactory::getSheetModelDataFlowParameterName	(	iv::gui::sheets::ColumnId	columnId,
		iv::comms::eProtocolType	protocolType,
		bool	shortName )

static

Gets the parameter name for the SheetModelDataFlow object.

Parameters

columnId	The column ID to get the parameter name.
protocolType	The protocol type to get the parameter name.
shortName	The flag to get the short name.

Returns: The parameter name for the SheetModelDataFlow object.

◆ prvCreateButtonCellDefinition()

iv::gui::sheets::CellDefinition CSheetModelFactory::prvCreateButtonCellDefinition ( const std::string & text )

staticinherited

◆ removeColumnDefinitionFromSheetModel()

void CSheetModelFactory::removeColumnDefinitionFromSheetModel	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::ColumnId &	columnId )

staticinherited

◆ removeRow()

void CSheetModelFactory::removeRow	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::gui::sheets::RowId &	rowId )

staticinherited

◆ updateCSheetModelTankCalibrationTable()

void CSheetModelFactory::updateCSheetModelTankCalibrationTable	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const std::shared_ptr< iv::tanks::TrimCalibrationData > &	calibrationDataRef )

staticinherited

◆ updateRowTitles()

void CSheetModelFactory::updateRowTitles ( const std::shared_ptr< AbstractSheetModel > & sheetModel )

staticinherited

◆ updateSheetModelDataFlow()

void iv::gui::factory::SheetModelDataFlowFactory::updateSheetModelDataFlow	(	const std::shared_ptr< AbstractSheetModel > &	sheetModel,
		const iv::types::networkId &	networkId )

static

Updates the SheetModelDataFlow object with the new data.

Parameters

sheetModel	The reference to the SheetModelDataFlow object to update.
networkId	The network ID to update the SheetModelDataFlow object.

Member Data Documentation

◆ kDefaultLanguageColumnPosition

const int32_t CSheetModelFactory::kDefaultLanguageColumnPosition = 9

inlinestaticinherited

◆ kNoId

const int32_t CSheetModelFactory::kNoId = 0

inlinestaticinherited

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

src/ui/gui/sheets/SheetModelDataFlowFactory.hpp
src/ui/gui/sheets/SheetModelDataFlowFactory.cpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ addColumnDefinitionToSheetModel()

◆ addCommonCellDefinitionListeners()

◆ addRowDefinitionToSheetModel()

◆ addRowToCSheetModelTankCalibrationTable()

◆ addRowToSheetModelDataFlow()

◆ createCSheetModelTankCalibrationTable()

◆ createSheetModelDataFlow()

◆ findLowerBoundRow()

◆ findLowerBoundRowCheckingInAscendingPositionOrder()

◆ getCSheetModelTankCalibrationTableColumnName()

◆ getSheetModelDataFlowColumnName()

◆ getSheetModelDataFlowColumnWidth()

◆ getSheetModelDataFlowParameterName()

◆ prvCreateButtonCellDefinition()

◆ removeColumnDefinitionFromSheetModel()

◆ removeRow()

◆ updateCSheetModelTankCalibrationTable()

◆ updateRowTitles()

◆ updateSheetModelDataFlow()

Member Data Documentation

◆ kDefaultLanguageColumnPosition

◆ kNoId