covise::coPort Class Reference

#include <coPort.h>

Inheritance diagram for covise::coPort:

Collaboration diagram for covise::coPort:

Public Member Functions
	coPort (const char *name, const char *desc)
virtual	~coPort ()
	Destructor : virtual in case we derive objects. More...
virtual void	initialize ()=0
	give all necessary info to Covise -> automatically called ! More...
virtual void	print (ostream &str) const =0
	print *this to a stream More...
virtual const char *	getName () const
	get the name of this object More...
virtual const char *	getDesc () const
	get the description of this object More...
virtual Kind	kind () const =0
	return my type of element: coUifElem::{INPORT,OUTPORT,SWITCH,PARAM} More...
int	isConnected () const
	Return whether this port is connected -> valid only in compute() More...
void	setInfo (const char *value) const
	Set the info Popup text. More...
Public Member Functions inherited from covise::coUifElem
virtual	~coUifElem ()
	Destructor : virtual because we derive objects. More...
virtual void	hide ()
	Hide everything below. More...
virtual void	show ()
	Show everything below. More...
virtual Kind	kind () const =0
	return my type of element More...
virtual const char *	getName () const =0
	get the name of this object More...
virtual void	initialize ()=0
	give all necessary info to Covise -> automatically called by coModule in init() More...
virtual int	switchable () const
	whether this may be a part of a switch group More...
virtual int	paramChange ()
	handle parameter changes: called by paramCB More...
virtual int	preCompute ()
	do whatever is needed before compute CB : pre-set to do nothing More...
virtual int	postCompute ()
	do whatever is needed after compute CB : pre-set to do nothing More...

Protected Types
typedef int	Typeinfo

Protected Attributes
char *	d_name
char *	d_desc
char *	d_defString
int	d_init

Additional Inherited Members
Public Types inherited from covise::coUifElem
enum	Kind { SWITCH , PARAM , INPORT , OUTPORT }
	enum Kind: SWITCH, PARAM, INPORT, OUTPORT More...

Member Typedef Documentation

Typeinfo

typedef int covise::coPort::Typeinfo

protected

Constructor & Destructor Documentation

coPort()

coPort::coPort	(	const char *	name,
		const char *	desc
	)

~coPort()

coPort::~coPort ( )

virtual

Destructor : virtual in case we derive objects.

Member Function Documentation

getDesc()

const char * coPort::getDesc ( ) const

virtual

get the description of this object

getName()

const char * coPort::getName ( ) const

virtual

get the name of this object

Implements covise::coUifElem.

initialize()

virtual void covise::coPort::initialize ( )

pure virtual

give all necessary info to Covise -> automatically called !

Implements covise::coUifElem.

Implemented in covise::coBooleanParam, covise::coChoiceParam, covise::coColormapChoiceParam, covise::coColormapParam, covise::coColorParam, covise::coFileBrowserParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coFloatVectorParam, covise::coInputPort, covise::coIntScalarParam, covise::coIntSliderParam, covise::coIntVectorParam, covise::coMaterialParam, covise::coOutputPort, covise::coStringParam, covise::coTimerParam, and covise::coUifPara.

isConnected()

int coPort::isConnected

(

)

const

Return whether this port is connected -> valid only in compute()

kind()

virtual Kind covise::coPort::kind ( ) const

pure virtual

return my type of element: coUifElem::{INPORT,OUTPORT,SWITCH,PARAM}

Implements covise::coUifElem.

Implemented in covise::coInputPort, covise::coOutputPort, and covise::coUifPara.

print()

virtual void covise::coPort::print ( ostream &  str ) const

pure virtual

print *this to a stream

Implemented in covise::coInputPort, covise::coOutputPort, covise::coBooleanParam, covise::coChoiceParam, covise::coColormapChoiceParam, covise::coColormapParam, covise::coColorParam, covise::coFileBrowserParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coFloatVectorParam, covise::coIntScalarParam, covise::coIntSliderParam, covise::coIntVectorParam, covise::coMaterialParam, covise::coStringParam, covise::coTimerParam, and covise::coUifPara.

setInfo()

void coPort::setInfo

(

const char *

value

)

const

Set the info Popup text.

Member Data Documentation

d_defString

char* covise::coPort::d_defString

protected

d_desc

char * covise::coPort::d_desc

protected

d_init

int covise::coPort::d_init

protected

d_name

char* covise::coPort::d_name

protected

---

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

• api/coPort.h
• api/coPort.cpp