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

#include <WSPort.h>

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

Public Types

enum  PortType { Default, Optional, Dependent }
 

Public Slots

const QString & getName () const
 
const QStringList & getTypes () const
 
PortType getPortType () const
 
const covise::WSModulegetModule () const
 
const QString & getID () const
 

Public Member Functions

 WSPort (const covise::WSModule *module, const QString &name, const QStringList &acceptedTypes, PortType portType)
 
 WSPort (const covise::WSModule *module, const covise::covise__Port &port)
 
virtual ~WSPort ()
 
void setName (const QString &inName)
 
void setTypes (const QStringList &types)
 
void setPortType (PortType inPortType)
 
virtual covise::covise__Port getSerialisable () const
 
void setFromSerialisable (const covise::WSModule *module, const covise::covise__Port &serialisable)
 

Properties

QString name
 
QString id
 
QStringList types
 
PortType portType
 

Private Attributes

QString portName
 
QStringList dataTypes
 
const covise::WSModulemodule
 

Member Enumeration Documentation

Enumerator
Default 
Optional 
Dependent 

Constructor & Destructor Documentation

covise::WSPort::WSPort ( const covise::WSModule module,
const QString &  name,
const QStringList &  acceptedTypes,
PortType  portType 
)
covise::WSPort::WSPort ( const covise::WSModule module,
const covise::covise__Port &  port 
)
covise::WSPort::~WSPort ( )
virtual

Member Function Documentation

const QString& covise::WSPort::getID ( ) const
inlineslot

Get the port ID

const covise::WSModule* covise::WSPort::getModule ( ) const
inlineslot

Get the module this port belongs to

const QString& covise::WSPort::getName ( ) const
inlineslot

Get the name of the port

PortType covise::WSPort::getPortType ( ) const
inlineslot

Get the type of the port (default, optional, dependent)

covise__Port covise::WSPort::getSerialisable ( ) const
virtual
const QStringList& covise::WSPort::getTypes ( ) const
inlineslot

Get the data types accepted or created by the port

void covise::WSPort::setFromSerialisable ( const covise::WSModule module,
const covise::covise__Port &  serialisable 
)
void covise::WSPort::setName ( const QString &  inName)
inline

Set the name of the port

Parameters
inNameThe new value of portName
void covise::WSPort::setPortType ( PortType  inPortType)
inline

Set the type of the port (default, optional, dependent)

Parameters
inPortTypeThe new value of portType
void covise::WSPort::setTypes ( const QStringList &  types)
inline

Set the data types accepted or created by the port

Parameters
inTypeThe new value of dataTypes

Member Data Documentation

QStringList covise::WSPort::dataTypes
private
const covise::WSModule* covise::WSPort::module
private
QString covise::WSPort::portName
private

Property Documentation

QString covise::WSPort::id
read
QString covise::WSPort::name
read
PortType covise::WSPort::portType
read
QStringList covise::WSPort::types
read

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