sxInPort Class Reference

Input port (terminal). More...

#include <sxPort.h>

Inheritance diagram for sxInPort:

List of all members.

Classes
class	PrivateData
Public Member Functions
virtual	~sxInPort ()
	Free memory.
	sxInPort (const QString &cap=QString(), sxComponent *comp=0)
	Construct input port.
void	RemoveConnection (sxConnection *con)
	remove connection from reference list
void	AddConnection (sxConnection *con)
	add new connection.
sxConnection *	Connection (unsigned int idx=0) const
	Get the connection.
bool	IsConnectable (sxPort *p=0) const
	Check if this port is connectable to p.
void	Clear ()
	clear ports
bool	Open ()
	Open port.
bool	Close ()
	Close Port and drop data buffer.
void	Write (sxPacket *packet)
	Write packet to queue.
sxPacket *	Read ()
	read data
sxPacket *	ReadConfiguration ()
sxPacket *	TryRead ()
size_t	PendingPacketsCount () const

---

Detailed Description

Input port (terminal).

---

Constructor & Destructor Documentation

sxInPort::~sxInPort

(

)

[virtual]

Free memory.

All connetion attached to this port will also freed.

References Close(), and sxPort::RemoveConnection().

sxInPort::sxInPort	(	const QString &	cap = QString(),
		sxComponent *	comp = 0
	)

Construct input port.

Parameters:

	cap	caption
	comp	owner/parent component

References sxCaptionItem::SetCaption(), and sxPort::SetPortId().

---

Member Function Documentation

void sxInPort::AddConnection

(

sxConnection *

con

)

[virtual]

add new connection.

Old connection will be overwrited

Parameters:

con

the connection

Implements sxPort.

sxConnection * sxInPort::Connection

(

unsigned int

idx = 0

)

const [virtual]

Get the connection.

Parameters:

idx

connection index (not used)

Implements sxPort.

bool sxInPort::IsConnectable

(

sxPort *

p = 0

)

const [virtual]

Check if this port is connectable to p.

Parameters:

p

port

Returns:

true if no connection assigned and p is output port.

Implements sxPort.

References sxPort::IsOutput().

Referenced by sxUiInPort::MakeConnection().

bool sxInPort::Open

(

)

[virtual]

Open port.

For output port, propagate type and set channel count of connected port.

Reimplemented from sxPort.

References sxPort::IsOpen(), and sxPort::Open().

Referenced by sxOutPort::Open().

void sxInPort::RemoveConnection

(

sxConnection *

con

)

[virtual]

remove connection from reference list

Parameters:

con

the connection

Implements sxPort.

---

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

• src/sdk/sxPort.h
• src/sdk/sxPort.cpp