ModulePort Class Reference

Input ports for Module. More...

#include <ModulePort.h>

Inheritance diagram for ModulePort:

Collaboration diagram for ModulePort:

Public Member Functions
	ModulePort (std::string name, std::string description, Module *parent=nullptr)
virtual	~ModulePort ()
virtual std::string	getPortName ()
ModulePortType	getPortType ()
void	setPortType (ModulePortType portType)
virtual std::vector< Module * > &	getModules ()
virtual bool	isKindOf (Module *m)=0
virtual bool	hasModule (Module *m)=0
Module *	getParent ()
virtual void	clear ()
void	attach (std::shared_ptr< FCallBackFunc > func)

Protected Member Functions
virtual bool	addModule (Module *m)=0
virtual bool	removeModule (Module *m)=0
virtual void	notify ()

Protected Attributes
std::vector< Module * >	mModules

Private Attributes
Module *	m_parent = nullptr
std::string	m_name
std::string	m_description
ModulePortType	m_portType
std::vector< std::shared_ptr< FCallBackFunc > >	mCallbackFunc

Friends
class	Module

Detailed Description

Input ports for Module.

Definition at line 37 of file ModulePort.h.

Constructor & Destructor Documentation

ModulePort()

dyno::ModulePort::ModulePort	(	std::string	name,
		std::string	description,
		Module *	parent = nullptr )

Definition at line 7 of file ModulePort.cpp.

~ModulePort()

virtual dyno::ModulePort::~ModulePort ( )

inlinevirtual

Definition at line 41 of file ModulePort.h.

Member Function Documentation

addModule()

virtual bool dyno::ModulePort::addModule ( Module * m )

protectedpure virtual

attach()

void dyno::ModulePort::attach

(

std::shared_ptr< FCallBackFunc >

func

)

Definition at line 31 of file ModulePort.cpp.

clear()

void dyno::ModulePort::clear ( )

virtual

Definition at line 26 of file ModulePort.cpp.

getModules()

virtual std::vector< Module * > & dyno::ModulePort::getModules ( )

inlinevirtual

Definition at line 49 of file ModulePort.h.

getParent()

Module * dyno::ModulePort::getParent ( )

inline

Definition at line 56 of file ModulePort.h.

getPortName()

virtual std::string dyno::ModulePort::getPortName ( )

inlinevirtual

Definition at line 43 of file ModulePort.h.

getPortType()

ModulePortType dyno::ModulePort::getPortType

(

)

Definition at line 16 of file ModulePort.cpp.

hasModule()

virtual bool dyno::ModulePort::hasModule ( Module * m )

pure virtual

isKindOf()

virtual bool dyno::ModulePort::isKindOf ( Module * m )

pure virtual

notify()

void dyno::ModulePort::notify ( )

protectedvirtual

Definition at line 36 of file ModulePort.cpp.

removeModule()

virtual bool dyno::ModulePort::removeModule ( Module * m )

protectedpure virtual

setPortType()

void dyno::ModulePort::setPortType

(

ModulePortType

portType

)

Definition at line 21 of file ModulePort.cpp.

Friends And Related Symbol Documentation

Module

friend class Module

friend

Definition at line 82 of file ModulePort.h.

Member Data Documentation

m_description

std::string dyno::ModulePort::m_description

private

Definition at line 77 of file ModulePort.h.

m_name

std::string dyno::ModulePort::m_name

private

Definition at line 76 of file ModulePort.h.

m_parent

Module* dyno::ModulePort::m_parent = nullptr

private

Definition at line 74 of file ModulePort.h.

m_portType

ModulePortType dyno::ModulePort::m_portType

private

Definition at line 78 of file ModulePort.h.

mCallbackFunc

std::vector<std::shared_ptr<FCallBackFunc> > dyno::ModulePort::mCallbackFunc

private

Definition at line 80 of file ModulePort.h.

mModules

std::vector<Module*> dyno::ModulePort::mModules

protected

Definition at line 70 of file ModulePort.h.

---

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

• D:/Peridyno/peridyno/src/Framework/ModulePort.h
• D:/Peridyno/peridyno/src/Framework/ModulePort.cpp