CLogicsComponent Class Reference

#include <CLogicsComponent.hpp>

Inheritance diagram for CLogicsComponent:

Collaboration diagram for CLogicsComponent:

Public Types
typedef std::map< AbstractCanvasItem::TId, std::shared_ptr< CLogicsConnectionPoint > >	TMapIdConnPoint
enum class	EPartType {   MainShape , MainText , SubText1 , SubText2 ,   SubText3 }
typedef std::pair< TIndex, EPartType >	TPairIndexPartType
typedef std::map< TIndex, EPartType >	TMapIndexPartType
typedef std::map< TPairIndexPartType, AbstractCanvasItem::TTupleDrawingMode >	TMapPartTypeDrawingMode
typedef std::map< AbstractCanvasItem::TTupleDrawingMode, TMapPartTypeDrawingMode >	TMapDrawingModePartsDrawingMode
enum class	EMarkMode { None , Selected }
enum class	EStandOutMode { Highlighted , Warning , None }
typedef uint32_t	TId
typedef std::pair< double, double >	TPosition2d
typedef uint32_t	TIndex
typedef std::tuple< EMarkMode, EStandOutMode >	TTupleDrawingMode

Public Member Functions
	CLogicsComponent (const iv::types::logic::ComponentType &componentTypeTuple)
	CLogicsComponent (AbstractCanvasItem::TId id, const iv::types::logic::ComponentType &componentTypeTuple, const std::string &name)
	CLogicsComponent ()=delete
	~CLogicsComponent () override=default
	CLogicsComponent (const CLogicsComponent &other)=delete
	CLogicsComponent (CLogicsComponent &&other)=delete
CLogicsComponent &	operator= (const CLogicsComponent &other)=delete
CLogicsComponent &	operator= (CLogicsComponent &&other)=delete
iv::file::xml::node	read (const iv::file::xml::node &node) override
iv::file::xml::node	save (iv::file::xml::node &node) const override
std::vector< std::shared_ptr< AbstractCanvasItem > >	getLinkedItems () override
void	updateLinkedItems () override
void	resetLinkedItems () override
void	addConnectionPointInput (const std::shared_ptr< CLogicsConnectionPoint > &connectionPoint)
void	addConnectionPointOutput (const std::shared_ptr< CLogicsConnectionPoint > &connectionPoint)
size_t	numberOfInputs () const
size_t	numberOfOutputs () const
bool	isAllConnected () const
const iv::types::logic::componentFinalType &	getComponentFinalType () const
const iv::logic::eGeneralType &	getComponentGeneralType () const
const iv::types::logic::componentType &	getComponentType () const
const iv::types::logic::ComponentType &	getComponentTypeTuple () const
std::shared_ptr< CLogicsConnectionPoint >	getConnectionPoint (iv::logic::eDBBlockParamType pointType, iv::types::logic::paramNumber paramNum)
std::shared_ptr< CLogicsConnectionPoint >	getFirstInputConnectionPoint () const
std::shared_ptr< CLogicsConnectionPoint >	getInputConnectionPoint (uint32_t index)
std::shared_ptr< CLogicsConnectionPoint >	getFirstOutputConnectionPoint () const
std::shared_ptr< CLogicsConnectionPoint >	getOutputConnectionPoint (uint32_t index)
TMapIdConnPoint	getInputRefs ()
const TMapIdConnPoint &	getInputRefsConst () const
TMapIdConnPoint	getOutputRefs ()
const TMapIdConnPoint &	getOutputRefsConst () const
std::set< std::shared_ptr< CLogicsConnectionPoint > >	getConnectionPoints () const
virtual std::string	maxText () const
const iv::logic::eLogicsElementType &	getElementType () const
const std::string &	getElementName () const
virtual std::string	getMainText () const
virtual std::string	getDescriptiveText () const
virtual std::optional< iv::types::Size >	getDefaultSize () const
void	addListenerClick (std::unique_ptr< IListenerCanvasItemClick > listener)
void	addListenerMove (std::unique_ptr< IListenerCanvasItemMove > listener)
void	addListenerEnter (std::unique_ptr< IListenerCanvasItemEnter > listener)
void	addListenerLeave (std::unique_ptr< IListenerCanvasItemLeave > listener)
void	runListenersClick (CEventCanvasButton *evtCanvasButton)
void	runListenersMove (CEventCanvasButton *evtCanvasButton)
void	runListenersEnter ()
void	runListenersLeave ()
void	setCanvasItem (ICanvasItem *canvasItem)
void	setCurrentMarkMode (EMarkMode markMode)
void	setCurrentStandoutMode (EStandOutMode standoutMode)
void	setGlobalPosition2d (const TPosition2d &position2d)
void	setId (TId id)
void	setRedrawFlag (bool redraw)
ICanvasItem *	getCanvasItem ()
const ICanvasItem *	getCanvasItem () const
const AbstractCanvasItem::TTupleDrawingMode &	getCurrentDrawingMode () const
const TPosition2d &	getGlobalPosition2d () const
TId	getId () const
bool	getRedrawFlag () const

Static Public Member Functions
static iv::logic::eGeneralType	enumGeneralType (const std::string &strType)
static std::string	strGeneralType (iv::logic::eGeneralType generalType)
static iv::types::logic::ComponentType	readLogicsComponentTypeTuple (const iv::file::xml::node &node)
static bool	hasExecutionOrder (const iv::types::logic::ComponentType &componentTypeTuple)
static bool	isExecBlock (const iv::types::logic::ComponentType &componentTypeTuple)
static bool	isLibraryBlock (const iv::types::logic::ComponentType &componentTypeTuple)
static iv::logic::eLogicsElementType	enumLogicsElementType (const std::string &strType)
static std::string	strLogicsElementType (iv::logic::eLogicsElementType type)
static iv::logic::eLogicsElementType	readLogicsElementType (const iv::file::xml::node &node)

Static Public Attributes
static constexpr std::string_view	kPrvKeySectionLogicsElementData = "LogicsElementData"
static const TId	kInvalidCanvasItemId = 0
static const TId	kStartingCanvasItemId = 1
static const TPosition2d	kZeroPosition = {0., 0.}

Protected Member Functions
virtual std::optional< uint32_t >	getIndexOfConnectionForParam (iv::logic::eDBBlockParamType type, iv::types::logic::paramNumber number) const

Private Attributes
iv::types::logic::ComponentType	m_componentTypeTuple
TMapIdConnPoint	m_inputRefs
TMapIdConnPoint	m_outputRefs
iv::logic::eLogicsElementType	m_logicsElementType
std::string	m_name
TId	m_id
TPosition2d	m_globalPosition2d
TTupleDrawingMode	m_currentDrawingMode
bool	m_redrawFlag
ICanvasItem *	m_canvasItem
std::vector< std::unique_ptr< IListenerCanvasItemClick > >	m_listenersItemClick
std::vector< std::unique_ptr< IListenerCanvasItemMove > >	m_listenersItemMove
std::vector< std::unique_ptr< IListenerCanvasItemEnter > >	m_listenersItemEnter
std::vector< std::unique_ptr< IListenerCanvasItemLeave > >	m_listenersItemLeave

Detailed Description

An object of CLogicsComponent will hold ownership of its CLogicsConnectionPoint inputs and outputs.

Member Typedef Documentation

TId

uint32_t AbstractCanvasItem::TId

inherited

TIndex

uint32_t AbstractCanvasItem::TIndex

inherited

TMapDrawingModePartsDrawingMode

std::map<AbstractCanvasItem::TTupleDrawingMode, TMapPartTypeDrawingMode> AbstractLogicsElement::TMapDrawingModePartsDrawingMode

inherited

TMapIdConnPoint

std::map<AbstractCanvasItem::TId, std::shared_ptr<CLogicsConnectionPoint> > CLogicsComponent::TMapIdConnPoint

TMapIndexPartType

std::map<TIndex, EPartType> AbstractLogicsElement::TMapIndexPartType

inherited

TMapPartTypeDrawingMode

std::map<TPairIndexPartType, AbstractCanvasItem::TTupleDrawingMode> AbstractLogicsElement::TMapPartTypeDrawingMode

inherited

TPairIndexPartType

std::pair<TIndex, EPartType> AbstractLogicsElement::TPairIndexPartType

inherited

TPosition2d

std::pair<double, double> AbstractCanvasItem::TPosition2d

inherited

TTupleDrawingMode

std::tuple<EMarkMode, EStandOutMode> AbstractCanvasItem::TTupleDrawingMode

inherited

Member Enumeration Documentation

EMarkMode

enum class AbstractCanvasItem::EMarkMode

stronginherited

Enumeration defining the different modes to mark a logic element or a part of a logic element.

Enumerator
None
Selected

EPartType

enum class AbstractLogicsElement::EPartType

stronginherited

Enumeration defining the types of parts a logic element can be made of.

Enumerator
MainShape
MainText
SubText1
SubText2
SubText3

EStandOutMode

enum class AbstractCanvasItem::EStandOutMode

stronginherited

Enumeration defining the different modes to stand out a logic element or a part of a logic element.

Enumerator
Highlighted
Warning
None

Constructor & Destructor Documentation

CLogicsComponent() [1/5]

CLogicsComponent::CLogicsComponent ( const iv::types::logic::ComponentType & componentTypeTuple )

explicit

CLogicsComponent() [2/5]

CLogicsComponent::CLogicsComponent	(	AbstractCanvasItem::TId	id,
		const iv::types::logic::ComponentType &	componentTypeTuple,
		const std::string &	name )

CLogicsComponent() [3/5]

CLogicsComponent::CLogicsComponent ( )

delete

~CLogicsComponent()

CLogicsComponent::~CLogicsComponent ( )

overridedefault

CLogicsComponent() [4/5]

CLogicsComponent::CLogicsComponent ( const CLogicsComponent & other )

delete

CLogicsComponent() [5/5]

CLogicsComponent::CLogicsComponent ( CLogicsComponent && other )

delete

Member Function Documentation

addConnectionPointInput()

void CLogicsComponent::addConnectionPointInput

(

const std::shared_ptr< CLogicsConnectionPoint > &

connectionPoint

)

addConnectionPointOutput()

void CLogicsComponent::addConnectionPointOutput

(

const std::shared_ptr< CLogicsConnectionPoint > &

connectionPoint

)

addListenerClick()

void AbstractCanvasItem::addListenerClick ( std::unique_ptr< IListenerCanvasItemClick > listener )

inherited

addListenerEnter()

void AbstractCanvasItem::addListenerEnter ( std::unique_ptr< IListenerCanvasItemEnter > listener )

inherited

addListenerLeave()

void AbstractCanvasItem::addListenerLeave ( std::unique_ptr< IListenerCanvasItemLeave > listener )

inherited

addListenerMove()

void AbstractCanvasItem::addListenerMove ( std::unique_ptr< IListenerCanvasItemMove > listener )

inherited

enumGeneralType()

iv::logic::eGeneralType CLogicsComponent::enumGeneralType ( const std::string & strType )

static

enumLogicsElementType()

iv::logic::eLogicsElementType AbstractLogicsElement::enumLogicsElementType ( const std::string & strType )

staticinherited

getCanvasItem() [1/2]

ICanvasItem * AbstractCanvasItem::getCanvasItem ( )

inherited

getCanvasItem() [2/2]

const ICanvasItem * AbstractCanvasItem::getCanvasItem ( ) const

nodiscardinherited

getComponentFinalType()

const iv::types::logic::componentFinalType & CLogicsComponent::getComponentFinalType ( ) const

nodiscard

getComponentGeneralType()

const iv::logic::eGeneralType & CLogicsComponent::getComponentGeneralType ( ) const

nodiscard

getComponentType()

const iv::types::logic::componentType & CLogicsComponent::getComponentType ( ) const

nodiscard

getComponentTypeTuple()

const iv::types::logic::ComponentType & CLogicsComponent::getComponentTypeTuple ( ) const

nodiscard

getConnectionPoint()

std::shared_ptr< CLogicsConnectionPoint > CLogicsComponent::getConnectionPoint ( iv::logic::eDBBlockParamType pointType, iv::types::logic::paramNumber paramNum )

nodiscard

getConnectionPoints()

std::set< std::shared_ptr< CLogicsConnectionPoint > > CLogicsComponent::getConnectionPoints ( ) const

nodiscard

getCurrentDrawingMode()

const AbstractCanvasItem::TTupleDrawingMode & AbstractCanvasItem::getCurrentDrawingMode ( ) const

nodiscardinherited

getDefaultSize()

std::optional< iv::types::Size > AbstractLogicsElement::getDefaultSize ( ) const

virtualinherited

Reimplemented in iv::logic::component::LogicRectangle.

getDescriptiveText()

std::string AbstractLogicsElement::getDescriptiveText ( ) const

nodiscardvirtualinherited

Reimplemented in CLogicsComponentChannel, CLogicsComponentConstant, CLogicsComponentLabel, CLogicsComponentLibraryInOutBlock, iv::logic::component::LogicText, and LogicComponentBroadCastChannel.

getElementName()

const std::string & AbstractLogicsElement::getElementName ( ) const

nodiscardinherited

getElementType()

const iv::logic::eLogicsElementType & AbstractLogicsElement::getElementType ( ) const

nodiscardinherited

getFirstInputConnectionPoint()

std::shared_ptr< CLogicsConnectionPoint > CLogicsComponent::getFirstInputConnectionPoint ( ) const

nodiscard

getFirstOutputConnectionPoint()

std::shared_ptr< CLogicsConnectionPoint > CLogicsComponent::getFirstOutputConnectionPoint ( ) const

nodiscard

getGlobalPosition2d()

const AbstractCanvasItem::TPosition2d & AbstractCanvasItem::getGlobalPosition2d ( ) const

nodiscardinherited

getId()

AbstractCanvasItem::TId AbstractCanvasItem::getId ( ) const

nodiscardinherited

getIndexOfConnectionForParam()

std::optional< uint32_t > CLogicsComponent::getIndexOfConnectionForParam ( iv::logic::eDBBlockParamType type, iv::types::logic::paramNumber number ) const

protectedvirtual

Reimplemented in CLogicsComponentExec.

getInputConnectionPoint()

std::shared_ptr< CLogicsConnectionPoint > CLogicsComponent::getInputConnectionPoint ( uint32_t index )

nodiscard

getInputRefs()

CLogicsComponent::TMapIdConnPoint CLogicsComponent::getInputRefs

(

)

getInputRefsConst()

const CLogicsComponent::TMapIdConnPoint & CLogicsComponent::getInputRefsConst ( ) const

nodiscard

getLinkedItems()

std::vector< std::shared_ptr< AbstractCanvasItem > > CLogicsComponent::getLinkedItems ( )

overridevirtual

Reimplemented from AbstractLogicsElement.

getMainText()

std::string AbstractLogicsElement::getMainText ( ) const

nodiscardvirtualinherited

Reimplemented in CLogicsComponentChannel, and iv::logic::component::LogicText.

getOutputConnectionPoint()

std::shared_ptr< CLogicsConnectionPoint > CLogicsComponent::getOutputConnectionPoint ( uint32_t index )

nodiscard

getOutputRefs()

CLogicsComponent::TMapIdConnPoint CLogicsComponent::getOutputRefs

(

)

getOutputRefsConst()

const CLogicsComponent::TMapIdConnPoint & CLogicsComponent::getOutputRefsConst ( ) const

nodiscard

getRedrawFlag()

bool AbstractCanvasItem::getRedrawFlag ( ) const

nodiscardinherited

hasExecutionOrder()

bool CLogicsComponent::hasExecutionOrder ( const iv::types::logic::ComponentType & componentTypeTuple )

static

isAllConnected()

bool CLogicsComponent::isAllConnected ( ) const

nodiscard

isExecBlock()

bool CLogicsComponent::isExecBlock ( const iv::types::logic::ComponentType & componentTypeTuple )

static

isLibraryBlock()

bool CLogicsComponent::isLibraryBlock ( const iv::types::logic::ComponentType & componentTypeTuple )

static

maxText()

std::string AbstractLogicsElement::maxText ( ) const

nodiscardvirtualinherited

Reimplemented in CLogicsComponentChannel, CLogicsComponentConstant, CLogicsComponentLabel, CLogicsComponentLibraryInOutBlock, iv::logic::component::LogicText, and LogicComponentBroadCastChannel.

numberOfInputs()

size_t CLogicsComponent::numberOfInputs ( ) const

nodiscard

numberOfOutputs()

size_t CLogicsComponent::numberOfOutputs ( ) const

nodiscard

operator=() [1/2]

CLogicsComponent & CLogicsComponent::operator= ( CLogicsComponent && other )

delete

operator=() [2/2]

CLogicsComponent & CLogicsComponent::operator= ( const CLogicsComponent & other )

delete

read()

iv::file::xml::node CLogicsComponent::read ( const iv::file::xml::node & node )

overridevirtual

Reimplemented from AbstractLogicsElement.

Reimplemented in CLogicsComponentChannel, CLogicsComponentConstant, CLogicsComponentExec, CLogicsComponentLabel, CLogicsComponentLibrary, CLogicsComponentLibraryInOutBlock, CLogicsComponentOthers, and LogicComponentBroadCastChannel.

readLogicsComponentTypeTuple()

iv::types::logic::ComponentType CLogicsComponent::readLogicsComponentTypeTuple ( const iv::file::xml::node & node )

static

readLogicsElementType()

iv::logic::eLogicsElementType AbstractLogicsElement::readLogicsElementType ( const iv::file::xml::node & node )

staticinherited

resetLinkedItems()

void CLogicsComponent::resetLinkedItems ( )

overridevirtual

Reimplemented from AbstractLogicsElement.

runListenersClick()

void AbstractCanvasItem::runListenersClick ( CEventCanvasButton * evtCanvasButton )

inherited

runListenersEnter()

void AbstractCanvasItem::runListenersEnter ( )

inherited

runListenersLeave()

void AbstractCanvasItem::runListenersLeave ( )

inherited

runListenersMove()

void AbstractCanvasItem::runListenersMove ( CEventCanvasButton * evtCanvasButton )

inherited

save()

iv::file::xml::node CLogicsComponent::save ( iv::file::xml::node & node ) const

overridevirtual

Reimplemented from AbstractLogicsElement.

Reimplemented in CLogicsComponentChannel, CLogicsComponentConstant, CLogicsComponentExec, CLogicsComponentLabel, CLogicsComponentLibrary, CLogicsComponentLibraryInOutBlock, CLogicsComponentOthers, and LogicComponentBroadCastChannel.

setCanvasItem()

void AbstractCanvasItem::setCanvasItem ( ICanvasItem * canvasItem )

inherited

setCurrentMarkMode()

void AbstractCanvasItem::setCurrentMarkMode ( EMarkMode markMode )

inherited

setCurrentStandoutMode()

void AbstractCanvasItem::setCurrentStandoutMode ( EStandOutMode standoutMode )

inherited

setGlobalPosition2d()

void AbstractCanvasItem::setGlobalPosition2d ( const TPosition2d & position2d )

inherited

setId()

void AbstractCanvasItem::setId ( TId id )

inherited

setRedrawFlag()

void AbstractCanvasItem::setRedrawFlag ( bool redraw )

inherited

strGeneralType()

std::string CLogicsComponent::strGeneralType ( iv::logic::eGeneralType generalType )

static

strLogicsElementType()

std::string AbstractLogicsElement::strLogicsElementType ( iv::logic::eLogicsElementType type )

staticinherited

updateLinkedItems()

void CLogicsComponent::updateLinkedItems ( )

overridevirtual

Reimplemented from AbstractLogicsElement.

Member Data Documentation

kInvalidCanvasItemId

const TId AbstractCanvasItem::kInvalidCanvasItemId = 0

inlinestaticinherited

kPrvKeySectionLogicsElementData

std::string_view AbstractLogicsElement::kPrvKeySectionLogicsElementData = "LogicsElementData"

inlinestaticconstexprinherited

kStartingCanvasItemId

const TId AbstractCanvasItem::kStartingCanvasItemId = 1

inlinestaticinherited

kZeroPosition

const TPosition2d AbstractCanvasItem::kZeroPosition = {0., 0.}

inlinestaticinherited

m_canvasItem

ICanvasItem* AbstractCanvasItem::m_canvasItem

privateinherited

m_componentTypeTuple

iv::types::logic::ComponentType CLogicsComponent::m_componentTypeTuple

private

m_currentDrawingMode

TTupleDrawingMode AbstractCanvasItem::m_currentDrawingMode

privateinherited

m_globalPosition2d

TPosition2d AbstractCanvasItem::m_globalPosition2d

privateinherited

m_id

TId AbstractCanvasItem::m_id

privateinherited

m_inputRefs

TMapIdConnPoint CLogicsComponent::m_inputRefs

private

m_listenersItemClick

std::vector<std::unique_ptr<IListenerCanvasItemClick> > AbstractCanvasItem::m_listenersItemClick

privateinherited

m_listenersItemEnter

std::vector<std::unique_ptr<IListenerCanvasItemEnter> > AbstractCanvasItem::m_listenersItemEnter

privateinherited

m_listenersItemLeave

std::vector<std::unique_ptr<IListenerCanvasItemLeave> > AbstractCanvasItem::m_listenersItemLeave

privateinherited

m_listenersItemMove

std::vector<std::unique_ptr<IListenerCanvasItemMove> > AbstractCanvasItem::m_listenersItemMove

privateinherited

m_logicsElementType

iv::logic::eLogicsElementType AbstractLogicsElement::m_logicsElementType

privateinherited

m_name

std::string AbstractLogicsElement::m_name

privateinherited

m_outputRefs

TMapIdConnPoint CLogicsComponent::m_outputRefs

private

m_redrawFlag

bool AbstractCanvasItem::m_redrawFlag

privateinherited

---

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

• src/logic/components/CLogicsComponent.hpp
• src/logic/components/CLogicsComponent.cpp