iso::visual::PatchPort Class Reference

patch port class More...

#include <iso_visual_patch.h>

Inherited by iso::visual::PatchInputPort, and iso::visual::PatchOutputPort.

Inheritance diagram for iso::visual::PatchPort:

[legend]Collaboration diagram for iso::visual::PatchPort:

[legend]List of all members.

Public Member Functions
	PatchPort (const base::String &pName, PatchNode *pNode)
	constructor
	~PatchPort ()
	destructor
const base::String &	name () const
	return port name
PatchNode *	node ()
	return node this port is part of
bool	changed () const
	check change flag
virtual void	setChanged (bool pChanged)
	set change flag
virtual void	setPermChanged (bool pPermChanged)
	set permanent change flag
virtual void	update ()=0
	update port
Protected Attributes
base::String	mName
	port name
PatchNode *	mNode
	patch node this port is part of
bool	mChanged
	flag that indicates whether variable associated with port has changed
bool	mPermChanged

---

Detailed Description

patch port class

abstract patch port class.
a port is part of a patch node.
This class serves as abstract base class for input and output port classes.

---

Constructor & Destructor Documentation

PatchPort::PatchPort	(	const base::String &	pName,
		PatchNode *	pNode
	)

constructor

Parameters:

	pName	name of patch port
	pNode	node this port is part of

PatchPort::~PatchPort

(

)

destructor

---

Member Function Documentation

const base::String & PatchPort::name

(

)

const

return port name

Returns:

port name

PatchNode * PatchPort::node

(

)

return node this port is part of

Returns:

node this port is part of

bool PatchPort::changed

(

)

const

check change flag

Returns:

change flag

change flag indicates if variable associated with port has changed

void PatchPort::setChanged

(

bool

pChanged

)

[virtual]

set change flag

Parameters:

pChanged

changed flag

change flag indicates if variable associated with port has changed

Reimplemented in iso::visual::PatchOutputPort.

void PatchPort::setPermChanged

(

bool

pPermChanged

)

[virtual]

set permanent change flag

Parameters:

pChanged

permanent changed flag

change flag indicates if port is marked as permanently changed

virtual void iso::visual::PatchPort::update

(

)

[pure virtual]

update port

Implemented in iso::visual::PatchInputPort, iso::visual::PatchOutputPort, iso::visual::TypedPatchInputPort< DataType >, and iso::visual::TypedPatchOutputPort< DataType >.

---

Member Data Documentation

base::String iso::visual::PatchPort::mName [protected]

port name

PatchNode* iso::visual::PatchPort::mNode [protected]

patch node this port is part of

bool iso::visual::PatchPort::mChanged [protected]

flag that indicates whether variable associated with port has changed

bool iso::visual::PatchPort::mPermChanged [protected]

brief flag that indicates whether this part is marked as permanently changed

---

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

• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/patch/iso_visual_patch.h
• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/patch/iso_visual_patch.cpp

---