CLAM::TypedOutControl< TypedControlData > Class Template Reference

#include <TypedOutControl.hxx>

Inheritance diagram for CLAM::TypedOutControl< TypedControlData >:

List of all members.

---

Detailed Description

template<class TypedControlData>
class CLAM::TypedOutControl< TypedControlData >

Processing typed out control template class.

Definition at line 19 of file TypedOutControl.hxx.

Public Member Functions
	TypedOutControl (const std::string &name="unnamed typed in control", Processing *proc=0)
	~TypedOutControl ()
void	AddLink (TypedInControl< TypedControlData > &in)
void	AddLink (BaseTypedInControl &in)
void	RemoveLink (TypedInControl< TypedControlData > &in)
void	RemoveLink (BaseTypedInControl &in)
void	SendControl (const TypedControlData &val)
bool	IsConnected ()
bool	IsConnectedTo (TypedInControl< TypedControlData > &)
bool	IsConnectedTo (BaseTypedInControl &in)
bool	IsLinkable (const BaseTypedInControl &in)
std::list< BaseTypedInControl * > ::iterator	BeginInControlsConnected ()
std::list< BaseTypedInControl * > ::iterator	EndInControlsConnected ()
Protected Attributes
std::list< BaseTypedInControl * >	mLinks

---

Constructor & Destructor Documentation

template<class TypedControlData>

CLAM::TypedOutControl< TypedControlData >::TypedOutControl	(	const std::string &	name = "unnamed typed in control",
		Processing *	proc = 0
	)			[inline]

Definition at line 53 of file TypedOutControl.hxx.

template<class TypedControlData>

CLAM::TypedOutControl< TypedControlData >::~TypedOutControl

(

)

[inline]

Definition at line 59 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks, and CLAM::TypedOutControl< TypedControlData >::RemoveLink().

---

Member Function Documentation

template<class TypedControlData>

void CLAM::TypedOutControl< TypedControlData >::AddLink

(

TypedInControl< TypedControlData > &

in

)

[inline]

Definition at line 67 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks, and CLAM::TypedInControl< TypedControlData >::OutControlInterface_AddLink().

Referenced by CLAM::TypedOutControl< TypedControlData >::AddLink().

template<class TypedControlData>

void CLAM::TypedOutControl< TypedControlData >::AddLink

(

BaseTypedInControl &

in

)

[inline, virtual]

Warning:

You should call IsLinkable before using the Link function or you'll get an assert failure if In and Out Control types are different.

Implements CLAM::BaseTypedOutControl.

Definition at line 77 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::AddLink(), and CLAM_ASSERT.

template<class TypedControlData>

void CLAM::TypedOutControl< TypedControlData >::RemoveLink

(

TypedInControl< TypedControlData > &

in

)

[inline]

Definition at line 90 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks, and CLAM::TypedInControl< TypedControlData >::OutControlInterface_RemoveLink().

Referenced by CLAM::TypedOutControl< TypedControlData >::RemoveLink(), and CLAM::TypedOutControl< TypedControlData >::~TypedOutControl().

template<class TypedControlData>

void CLAM::TypedOutControl< TypedControlData >::RemoveLink

(

BaseTypedInControl &

in

)

[inline, virtual]

Implements CLAM::BaseTypedOutControl.

Definition at line 96 of file TypedOutControl.hxx.

References CLAM_ASSERT, and CLAM::TypedOutControl< TypedControlData >::RemoveLink().

template<class TypedControlData>

void CLAM::TypedOutControl< TypedControlData >::SendControl

(

const TypedControlData &

val

)

[inline]

Definition at line 108 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks.

template<class TypedControlData>

bool CLAM::TypedOutControl< TypedControlData >::IsConnected

(

)

[inline, virtual]

Implements CLAM::BaseTypedOutControl.

Definition at line 119 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks.

template<class TypedControlData>

bool CLAM::TypedOutControl< TypedControlData >::IsConnectedTo

(

TypedInControl< TypedControlData > &

in

)

[inline]

Definition at line 125 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks.

Referenced by CLAM::TypedOutControl< TypedControlData >::IsConnectedTo().

template<class TypedControlData>

bool CLAM::TypedOutControl< TypedControlData >::IsConnectedTo

(

BaseTypedInControl &

in

)

[inline, virtual]

Implements CLAM::BaseTypedOutControl.

Definition at line 143 of file TypedOutControl.hxx.

References CLAM_ASSERT, and CLAM::TypedOutControl< TypedControlData >::IsConnectedTo().

template<class TypedControlData>

bool CLAM::TypedOutControl< TypedControlData >::IsLinkable

(

const BaseTypedInControl &

in

)

[inline, virtual]

Implements CLAM::BaseTypedOutControl.

Definition at line 136 of file TypedOutControl.hxx.

References CLAM::BaseTypedInControl::ControlType().

template<class TypedControlData>

std::list< BaseTypedInControl * >::iterator CLAM::TypedOutControl< TypedControlData >::BeginInControlsConnected

(

)

[inline, virtual]

Implements CLAM::BaseTypedOutControl.

Definition at line 160 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks.

template<class TypedControlData>

std::list< BaseTypedInControl * >::iterator CLAM::TypedOutControl< TypedControlData >::EndInControlsConnected

(

)

[inline, virtual]

Implements CLAM::BaseTypedOutControl.

Definition at line 166 of file TypedOutControl.hxx.

References CLAM::TypedOutControl< TypedControlData >::mLinks.

---

Member Data Documentation

template<class TypedControlData>

std::list< BaseTypedInControl * > CLAM::TypedOutControl< TypedControlData >::mLinks [protected]

Definition at line 27 of file TypedOutControl.hxx.

Referenced by CLAM::TypedOutControl< TypedControlData >::AddLink(), CLAM::TypedOutControl< TypedControlData >::BeginInControlsConnected(), CLAM::TypedOutControl< TypedControlData >::EndInControlsConnected(), CLAM::TypedOutControl< TypedControlData >::IsConnected(), CLAM::TypedOutControl< TypedControlData >::IsConnectedTo(), CLAM::TypedOutControl< TypedControlData >::RemoveLink(), CLAM::TypedOutControl< TypedControlData >::SendControl(), and CLAM::TypedOutControl< TypedControlData >::~TypedOutControl().

---

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

• TypedOutControl.hxx