COVISE Core
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
Public Member Functions | Private Member Functions | Private Attributes | List of all members
covise::coOutputPort Class Reference

#include <coOutputPort.h>

Inheritance diagram for covise::coOutputPort:
Inheritance graph
[legend]
Collaboration diagram for covise::coOutputPort:
Collaboration graph
[legend]

Public Member Functions

 coOutputPort (const char *name, const char *typelist, const char *desc)
 
void setRequired (int isRequired)
 
void setDependencyPort (coInputPort *port)
 
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 ~coOutputPort ()
 Destructor : virtual in case we derive objects. More...
 
virtual int preCompute ()
 do whatever is necessary after a compute() More...
 
virtual int postCompute ()
 do whatever is necessary after a compute() : delete the object More...
 
void setCurrentObject (coDistributedObject *obj)
 set my active object if I have one More...
 
coDistributedObjectgetCurrentObject ()
 get my active object More...
 
const char * getObjName ()
 set my active object if I have one More...
 
coObjInfo getNewObjectInfo ()
 get my active object if I have one More...
 
void setObjName (const char *n)
 set object-name - should only be used by the api ! More...
 
void print (ostream &) const
 print to a stream 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 const char * getName () const
 get the name of this object More...
 
virtual const char * getDesc () const
 get the description of this object 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 int switchable () const
 whether this may be a part of a switch group More...
 
virtual int paramChange ()
 handle parameter changes: called by paramCB More...
 

Private Member Functions

 coOutputPort (const coOutputPort &)
 Copy-Constructor: NOT IMPLEMENTED. More...
 
coOutputPortoperator= (const coOutputPort &)
 Assignment operator: NOT IMPLEMENTED. More...
 
 coOutputPort ()
 Default constructor: NOT IMPLEMENTED. More...
 

Private Attributes

coDistributedObjectd_outObj
 Object at the output port. More...
 
char * d_objName
 Name for the output port object. More...
 
char * d_depPort
 Name of the port this one is depending on. More...
 

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 Output Port

Constructor & Destructor Documentation

covise::coOutputPort::coOutputPort ( const coOutputPort )
private

Copy-Constructor: NOT IMPLEMENTED.

covise::coOutputPort::coOutputPort ( )
private

Default constructor: NOT IMPLEMENTED.

coOutputPort::coOutputPort ( const char *  name,
const char *  typelist,
const char *  desc 
)
coOutputPort::~coOutputPort ( )
virtual

Destructor : virtual in case we derive objects.

Member Function Documentation

coDistributedObject * coOutputPort::getCurrentObject ( )

get my active object

coObjInfo coOutputPort::getNewObjectInfo ( )

get my active object if I have one

const char * coOutputPort::getObjName ( )

set my active object if I have one

get my active object if I have one

void coOutputPort::initialize ( )
virtual

give all necessary info to Covise -> automatically called !

Implements covise::coPort.

coUifElem::Kind coOutputPort::kind ( ) const
virtual

return my type of element: coUifElem::INPORT

Implements covise::coPort.

coOutputPort& covise::coOutputPort::operator= ( const coOutputPort )
private

Assignment operator: NOT IMPLEMENTED.

int coOutputPort::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.

int coOutputPort::preCompute ( )
virtual

do whatever is necessary after a compute()

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

Reimplemented from covise::coUifElem.

void coOutputPort::print ( ostream &  str) const
virtual

print to a stream

Implements covise::coPort.

void coOutputPort::setCurrentObject ( coDistributedObject obj)

set my active object if I have one

void coOutputPort::setDependencyPort ( coInputPort port)
void coOutputPort::setObjName ( const char *  n)

set object-name - should only be used by the api !

void covise::coOutputPort::setRequired ( int  isRequired)

Member Data Documentation

char* covise::coOutputPort::d_depPort
private

Name of the port this one is depending on.

char* covise::coOutputPort::d_objName
private

Name for the output port object.

coDistributedObject* covise::coOutputPort::d_outObj
private

Object at the output port.


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