A model to represent the ports of a module. More...

#include <port_tree_model.h>

Inheritance diagram for hal::ModulePinsTreeModel:

Collaboration diagram for hal::ModulePinsTreeModel:

Signals
void	numberOfPortsChanged (const int newNumber)

Public Member Functions
	ModulePinsTreeModel (QObject *parent=nullptr)

	~ModulePinsTreeModel ()

Qt::ItemFlags	flags (const QModelIndex &index) const override

QStringList	mimeTypes () const override

QMimeData *	mimeData (const QModelIndexList &indexes) const override

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const override

void	clear () override

void	setModule (Module *m)

Net *	getNetFromItem (PortTreeItem *item)

int	getRepresentedModuleId ()

Event Handler Functions
void	handleModulePortsChanged (Module *m, PinEvent pev, u32 pgid)

Public Member Functions inherited from hal::BaseTreeModel
	BaseTreeModel (QObject *parent=nullptr)

void	setContent (QList< BaseTreeItem * > firstLevelItems)

void	setHeaderLabels (const QStringList &label)

QStringList	headerLabels () const

QModelIndex	getIndexFromItem (BaseTreeItem *item) const

BaseTreeItem *	getItemFromIndex (QModelIndex index) const

BaseTreeItem *	getRootItem () const

void	insertChildItem (BaseTreeItem childItem, BaseTreeItem parentItem=nullptr, int row=-1)

virtual QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

virtual QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override

virtual QModelIndex	parent (const QModelIndex &index) const override

virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const override

virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const override

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

virtual	~QAbstractItemModel ()

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

virtual QModelIndex	sibling (int row, int column, const QModelIndex &index) const const

virtual bool	hasChildren (const QModelIndex &parent) const const

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual Qt::DropActions	supportedDropActions () const const

virtual Qt::DropActions	supportedDragActions () const const

void	setSupportedDragActions (Qt::DropActions actions)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	insertRow (int row, const QModelIndex &parent)

bool	insertColumn (int column, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

bool	removeColumn (int column, const QModelIndex &parent)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual void	fetchMore (const QModelIndex &parent)

virtual bool	canFetchMore (const QModelIndex &parent) const const

virtual void	sort (int column, Qt::SortOrder order)

virtual QModelIndex	buddy (const QModelIndex &index) const const

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

virtual QSize	span (const QModelIndex &index) const const

virtual QHash< int, QByteArray >	roleNames () const const

bool	checkIndex (const QModelIndex &index, QAbstractItemModel::CheckIndexOptions options) const const

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles)

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	modelAboutToBeReset ()

void	modelReset ()

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int column)

virtual bool	submit ()

virtual void	revert ()

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Static Public Attributes
static const int	sNameColumn = 0

static const int	sDirectionColumn = 1

static const int	sTypeColumn = 2

static const int	sNetColumn = 3

Additional Inherited Members
Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint

enum	CheckIndexOption

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions

	NoLayoutChangeHint

	VerticalSortHint

	HorizontalSortHint

	NoOption

	IndexIsValid

	DoNotUseParent

	ParentIsInvalid

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QAbstractItemModel
void	resetInternalData ()

QModelIndex	createIndex (int row, int column, void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	beginInsertRows (const QModelIndex &parent, int first, int last)

void	endInsertRows ()

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	endRemoveRows ()

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	endMoveRows ()

void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	endInsertColumns ()

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	endRemoveColumns ()

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	endMoveColumns ()

void	reset ()

void	beginResetModel ()

void	endResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndexList	persistentIndexList () const const

void	setRoleNames (const QHash< int, QByteArray > &roleNames)

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Protected Attributes inherited from hal::BaseTreeModel
RootTreeItem *	mRootItem

Properties inherited from QObject
	objectName

Detailed Description

A model to represent the ports of a module.

Definition at line 83 of file port_tree_model.h.

Constructor & Destructor Documentation

◆ ModulePinsTreeModel()

hal::ModulePinsTreeModel::ModulePinsTreeModel ( QObject * parent = nullptr )

The constructor.

Parameters

parent - THe model's parent.

Definition at line 79 of file port_tree_model.cpp.

References QObject::connect(), hal::Netlist::get_module_by_id(), hal::gNetlist, hal::gNetlistRelay, handleModulePortsChanged(), hal::NetlistRelay::modulePortsChanged(), hal::BaseTreeModel::setHeaderLabels(), and setModule().

◆ ~ModulePinsTreeModel()

hal::ModulePinsTreeModel::~ModulePinsTreeModel ( )

The destructor.

Definition at line 91 of file port_tree_model.cpp.

References hal::BaseTreeModel::mRootItem.

Member Function Documentation

◆ canDropMimeData()

bool hal::ModulePinsTreeModel::canDropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)		const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 211 of file port_tree_model.cpp.

References control::action, hal::BaseTreeModel::data(), hal::BaseTreeModel::getItemFromIndex(), hal::BaseTreeItem::getOwnRow(), hal::PortTreeItem::Group, id, QObject::parent(), hal::PortTreeItem::Pin, QIODevice::ReadOnly, and type.

◆ clear()

void hal::ModulePinsTreeModel::clear ( )

overridevirtual

Overwritten BaseTreeModel function.

Reimplemented from hal::BaseTreeModel.

Definition at line 263 of file port_tree_model.cpp.

References hal::BaseTreeModel::clear().

Referenced by hal::ModulePinsTree::removeContent(), and setModule().

◆ dropMimeData()

bool hal::ModulePinsTreeModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 151 of file port_tree_model.cpp.

References control::action, hal::BaseTreeModel::data(), hal::BaseTreeModel::getItemFromIndex(), id, QObject::parent(), QIODevice::ReadOnly, and type.

◆ flags()

Qt::ItemFlags hal::ModulePinsTreeModel::flags ( const QModelIndex & index ) const

overridevirtual

Overwritten Qt function that is necessary for the model. For further information pleaser refer to the Qt documentation.

Reimplemented from hal::BaseTreeModel.

Definition at line 96 of file port_tree_model.cpp.

References hal::BaseTreeModel::flags(), hal::BaseTreeModel::index(), Qt::ItemIsDragEnabled, and Qt::ItemIsDropEnabled.

◆ getNetFromItem()

Net * hal::ModulePinsTreeModel::getNetFromItem ( PortTreeItem * item )

Get the underlying net from an (port) item. If this model does not represent a module or an invalid (port) item is given a nullptr is returned.

Parameters

item	- The (port) item.

Returns: The net or nullptr.

Definition at line 356 of file port_tree_model.cpp.

References hal::Module::get_id(), hal::Netlist::get_module_by_id(), hal::Module::get_pin_by_id(), hal::BaseTreeItem::getChildCount(), hal::gNetlist, hal::PortTreeItem::Group, hal::PortTreeItem::id(), and hal::PortTreeItem::itemType().

Referenced by hal::ModulePinsTree::handleContextMenuRequested().

◆ getRepresentedModuleId()

int hal::ModulePinsTreeModel::getRepresentedModuleId ( )

Get the id of the module that is currently represented. If no module is represented, -1 is returned.

Returns: The module id.

Definition at line 377 of file port_tree_model.cpp.

References hal::Module::get_id().

Referenced by hal::ModulePinsTree::handleContextMenuRequested().

◆ handleModulePortsChanged()

void hal::ModulePinsTreeModel::handleModulePortsChanged	(	Module *	m,
		PinEvent	pev,
		u32	pgid
	)

Definition at line 383 of file port_tree_model.cpp.

References hal::BaseTreeModel::columnCount(), QSet::contains(), QAbstractItemModel::createIndex(), QAbstractItemModel::dataChanged(), QString::fromStdString(), hal::BasePin< T >::get_direction(), hal::PinGroup< T >::get_direction(), hal::BasePin< T >::get_group(), hal::BasePin< T >::get_id(), hal::PinGroup< T >::get_id(), hal::Net::get_name(), hal::BasePin< T >::get_name(), hal::PinGroup< T >::get_name(), hal::ModulePin::get_net(), hal::Module::get_pin_by_id(), hal::Module::get_pin_group_by_id(), hal::BasePin< T >::get_type(), hal::PinGroup< T >::get_type(), hal::BaseTreeModel::getIndexFromItem(), hal::PortTreeItem::Group, hal::GroupCreate, hal::GroupDelete, hal::GroupDirChange, hal::GroupRename, hal::GroupReorder, hal::GroupTypeChange, hal::PortTreeItem::id(), QModelIndex::internalPointer(), QModelIndex::isValid(), log_warning, hal::BaseTreeModel::mRootItem, hal::PortTreeItem::Pin, hal::PinAssignToGroup, hal::PinCreate, hal::PinDelete, hal::PinDirChange, hal::pinGroupIndex(), hal::pinIndex2Row(), hal::PinRename, hal::PinReorder, hal::PinTypeChange, QObject::Q_EMIT(), QModelIndex::row(), hal::PortTreeItem::setName(), hal::PortTreeItem::setPinDirection(), and hal::PortTreeItem::setPinType().

Referenced by ModulePinsTreeModel().

◆ mimeData()

QMimeData * hal::ModulePinsTreeModel::mimeData ( const QModelIndexList & indexes ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 133 of file port_tree_model.cpp.

References hal::BaseTreeModel::data(), hal::Module::get_id(), hal::BaseTreeModel::getItemFromIndex(), hal::PortTreeItem::id(), hal::PortTreeItem::itemType(), hal::PortTreeItem::Pin, hal::PyCodeProvider::pyCodeModulePinById(), hal::PyCodeProvider::pyCodeModulePinGroup(), type, and QIODevice::WriteOnly.

◆ mimeTypes()

QStringList hal::ModulePinsTreeModel::mimeTypes ( ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 126 of file port_tree_model.cpp.

◆ numberOfPortsChanged

void hal::ModulePinsTreeModel::numberOfPortsChanged ( const int newNumber )

signal

Q_SIGNAL that is emitted when the number of the model's port changed. (Primarily used to update 'the' section header in the details widget)

Parameters

newNumber - The new port count.

Referenced by hal::ModulePinsTree::ModulePinsTree(), and setModule().

◆ setModule()

void hal::ModulePinsTreeModel::setModule ( Module * m )

Sets up the model to display the module's ports.

Parameters

m	- The module for which to display the ports.

Definition at line 272 of file port_tree_model.cpp.

References hal::BaseTreeItem::appendChild(), QAbstractItemModel::beginResetModel(), clear(), QAbstractItemModel::endResetModel(), QString::fromStdString(), hal::Module::get_pin_groups(), hal::Module::get_pins(), hal::PortTreeItem::Group, hal::BaseTreeModel::mRootItem, numberOfPortsChanged(), hal::PortTreeItem::Pin, and QObject::Q_EMIT().

Referenced by ModulePinsTreeModel(), and hal::ModulePinsTree::setModule().

Member Data Documentation

◆ sDirectionColumn

const int hal::ModulePinsTreeModel::sDirectionColumn = 1

static

Definition at line 146 of file port_tree_model.h.

Referenced by hal::ModulePinsTree::handleContextMenuRequested().

◆ sNameColumn

const int hal::ModulePinsTreeModel::sNameColumn = 0

static

Definition at line 145 of file port_tree_model.h.

Referenced by hal::ModulePinsTree::handleContextMenuRequested().

◆ sNetColumn

const int hal::ModulePinsTreeModel::sNetColumn = 3

static

Definition at line 148 of file port_tree_model.h.

◆ sTypeColumn

const int hal::ModulePinsTreeModel::sTypeColumn = 2

static

Definition at line 147 of file port_tree_model.h.

Referenced by hal::ModulePinsTree::handleContextMenuRequested().

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

/home/runner/work/hal/hal/plugins/gui/include/gui/selection_details_widget/module_details_widget/port_tree_model.h
/home/runner/work/hal/hal/plugins/gui/src/selection_details_widget/module_details_widget/port_tree_model.cpp

Signals

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ModulePinsTreeModel()

◆ ~ModulePinsTreeModel()

Member Function Documentation

◆ canDropMimeData()

◆ clear()

◆ dropMimeData()

◆ flags()

◆ getNetFromItem()

◆ getRepresentedModuleId()

◆ handleModulePortsChanged()

◆ mimeData()

◆ mimeTypes()

◆ numberOfPortsChanged

◆ setModule()

Member Data Documentation

◆ sDirectionColumn

◆ sNameColumn

◆ sNetColumn

◆ sTypeColumn