Data input Port. More...

#include <coInputPort.h>

Inheritance diagram for covise::coInputPort:

[legend]

Collaboration diagram for covise::coInputPort:

[legend]

Public Member Functions
	coInputPort (const char name, const char typelist, const char *desc)

void	setRequired (int isRequired)

virtual void	initialize ()
	give all necessary info to Covise -> automatically called ! More...

virtual Kind	kind () const
	return my type of element: coUifElem::INPORT More...

virtual	~coInputPort ()
	Destructor : virtual in case we derive objects. More...

virtual int	preCompute ()
	do whatever is needed before compute CB : pre-set to do nothing More...

virtual int	postCompute ()
	do whatever is necessary after a compute() : delete the object More...

const coDistributedObject *	getCurrentObject () const
	get my active object if I have one More...

void	setCurrentObject (const coDistributedObject *o)
	set my active object - should only be used by the api More...

void	print (ostream &) const
	print to a stream More...

bool	inputDataChanged ()
	return true whether the input data changed since last execute. More...

Public Member Functions inherited from covise::coUifPort
	~coUifPort ()

	coUifPort (const char name, const char desc)

int	isConnected ()

virtual int	paramChange ()
	handle parameter changes: called by paramCB More...

Public Member Functions inherited from covise::coPort
	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...

Private Member Functions
	coInputPort (const coInputPort &)
	Copy-Constructor: NOT IMPLEMENTED. More...

coInputPort &	operator= (const coInputPort &)
	Assignment operator: NOT IMPLEMENTED. More...

	coInputPort ()
	Default constructor: NOT IMPLEMENTED. More...

Private Attributes
const coDistributedObject *	d_inObj
	Object at the input port. More...

char *	oldObjectName
	to check whether the Dataobject changed since last execute More...

bool	objectChanged

int	d_required

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

Protected Types inherited from covise::coPort
typedef int	Typeinfo

Protected Attributes inherited from covise::coPort
char *	d_name

char *	d_desc

char *	d_defString

int	d_init

Detailed Description

Data input Port.

Constructor & Destructor Documentation

◆ coInputPort() [1/3]

covise::coInputPort::coInputPort ( const coInputPort & )

private

Copy-Constructor: NOT IMPLEMENTED.

◆ coInputPort() [2/3]

covise::coInputPort::coInputPort ( )

private

Default constructor: NOT IMPLEMENTED.

◆ coInputPort() [3/3]

coInputPort::coInputPort	(	const char *	name,
		const char *	typelist,
		const char *	desc
	)

◆ ~coInputPort()

coInputPort::~coInputPort ( )

virtual

Destructor : virtual in case we derive objects.

Member Function Documentation

◆ getCurrentObject()

const coDistributedObject * coInputPort::getCurrentObject ( ) const

get my active object if I have one

◆ initialize()

void coInputPort::initialize ( )

virtual

give all necessary info to Covise -> automatically called !

Implements covise::coPort.

◆ inputDataChanged()

bool covise::coInputPort::inputDataChanged ( )

inline

return true whether the input data changed since last execute.

◆ kind()

coUifElem::Kind coInputPort::kind ( ) const

virtual

return my type of element: coUifElem::INPORT

Implements covise::coPort.

◆ operator=()

coInputPort & covise::coInputPort::operator= ( const coInputPort & )

private

Assignment operator: NOT IMPLEMENTED.

◆ postCompute()

int coInputPort::postCompute ( )

virtual

do whatever is necessary after a compute() : delete the object

do whatever is necessary before a compute() : get the object

Reimplemented from covise::coUifElem.

◆ preCompute()

int coInputPort::preCompute ( )

virtual

do whatever is needed before compute CB : pre-set to do nothing

do whatever is necessary before a compute() : get the object

Reimplemented from covise::coUifElem.

◆ print()

void coInputPort::print ( ostream & str ) const

virtual

print to a stream

Implements covise::coPort.

◆ setCurrentObject()

void coInputPort::setCurrentObject ( const coDistributedObject * o )

set my active object - should only be used by the api

◆ setRequired()

void coInputPort::setRequired ( int isRequired )

Member Data Documentation

◆ d_inObj

const coDistributedObject* covise::coInputPort::d_inObj

private

Object at the input port.

◆ d_required

int covise::coInputPort::d_required

private

◆ objectChanged

bool covise::coInputPort::objectChanged

private

◆ oldObjectName

char* covise::coInputPort::oldObjectName

private

to check whether the Dataobject changed since last execute

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

api/coInputPort.h
api/coInputPort.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coInputPort() [1/3]

◆ coInputPort() [2/3]

◆ coInputPort() [3/3]

◆ ~coInputPort()

Member Function Documentation

◆ getCurrentObject()

◆ initialize()

◆ inputDataChanged()

◆ kind()

◆ operator=()

◆ postCompute()

◆ preCompute()

◆ print()

◆ setCurrentObject()

◆ setRequired()

Member Data Documentation

◆ d_inObj

◆ d_required

◆ objectChanged

◆ oldObjectName