iso::visual::PatchInputPort Class Reference

patch input port class More...

#include <iso_visual_patch.h>

Inherits iso::visual::PatchPort.

Inherited by iso::visual::TypedPatchInputPort< DataType >.

Inheritance diagram for iso::visual::PatchInputPort:

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

[legend]List of all members.

Public Member Functions
	PatchInputPort (const base::String &pName, PatchNode *pNode)
	constructor
	~PatchInputPort ()
	destructor
int	connectionCount () const
	return number of connections (0 or 1)
virtual void	set (const PatchNodeData &pData)
	check if variable associated with this input port has changed directly set input port data
virtual void	connect (PatchOutputPort &pOutputPort)
	connect input port to output port
virtual void	disconnect ()
	disconnect input port from output port
virtual void	update ()
	update input port
Protected Attributes
PatchOutputPort *	mOutputPort

---

Detailed Description

patch input port class

a patch input port class that links a node to some external data.
This data is either provided manually by setting the port to a particular value,
or it is automatically provided by another node via a connection to this other node's output port.
An input port can be connected only to one single output port

---

Constructor & Destructor Documentation

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

constructor

Parameters:

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

PatchInputPort::~PatchInputPort

(

)

destructor

---

Member Function Documentation

int PatchInputPort::connectionCount

(

)

const

return number of connections (0 or 1)

Returns:

number of connectins (0 or 1)

void PatchInputPort::set

(

const PatchNodeData &

pData

)

[virtual]

check if variable associated with this input port has changed directly set input port data

Parameters:

pData

input port data

Reimplemented in iso::visual::TypedPatchInputPort< DataType >.

void PatchInputPort::connect

(

PatchOutputPort &

pOutputPort

)

[virtual]

connect input port to output port

Parameters:

pOutputPort

output port

Reimplemented in iso::visual::TypedPatchInputPort< DataType >.

void PatchInputPort::disconnect

(

)

[virtual]

disconnect input port from output port

Reimplemented in iso::visual::TypedPatchInputPort< DataType >.

void PatchInputPort::update

(

)

[virtual]

update input port

Implements iso::visual::PatchPort.

Reimplemented in iso::visual::TypedPatchInputPort< DataType >.

---

Member Data Documentation

PatchOutputPort* iso::visual::PatchInputPort::mOutputPort [protected]

/brief output port this input port is connect to

---

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

---