Developer Documentation
VSI::InOut Class Reference

#include <Plugin-VSI/parser/inout.hh>

Inheritance diagram for VSI::InOut:
VSI::Input VSI::Output

Public Member Functions

 InOut (Element *_e)
 Constructor. More...
 
const QString & name () const
 Name. More...
 
const QString & shortDescription () const
 Short description. More...
 
const QString & longDescription () const
 Long description. More...
 
const Elementelement () const
 Element of this input/output. More...
 
QMap< QString, QString > hints () const
 Parsed hints for this input/output type. More...
 
QString typeString () const
 Type. More...
 

Private Attributes

QString name_
 
QString shortDesc_
 
QString longDesc_
 
QString type_
 
QMap< QString, QString > hints_
 
Elementelement_
 

Friends

class Context
 

Detailed Description

Base class for element inputs and outputs. It holds all common data.

Definition at line 62 of file inout.hh.

Constructor & Destructor Documentation

◆ InOut()

VSI::InOut::InOut ( Element _e)
explicit

Constructor.

Definition at line 57 of file inout.cc.

Member Function Documentation

◆ element()

const Element * VSI::InOut::element ( ) const
inline

Element of this input/output.

Definition at line 79 of file inout.hh.

◆ hints()

QMap< QString, QString > VSI::InOut::hints ( ) const
inline

Parsed hints for this input/output type.

Definition at line 82 of file inout.hh.

◆ longDescription()

const QString & VSI::InOut::longDescription ( ) const
inline

Long description.

Definition at line 76 of file inout.hh.

◆ name()

const QString & VSI::InOut::name ( void  ) const
inline

Name.

Definition at line 70 of file inout.hh.

◆ shortDescription()

const QString & VSI::InOut::shortDescription ( ) const
inline

Short description.

Definition at line 73 of file inout.hh.

◆ typeString()

QString VSI::InOut::typeString ( ) const

Type.

Definition at line 65 of file inout.cc.

Friends And Related Function Documentation

◆ Context

friend class Context
friend

Definition at line 87 of file inout.hh.

Member Data Documentation

◆ element_

Element* VSI::InOut::element_
private

Definition at line 98 of file inout.hh.

◆ hints_

QMap<QString, QString> VSI::InOut::hints_
private

Definition at line 96 of file inout.hh.

◆ longDesc_

QString VSI::InOut::longDesc_
private

Definition at line 92 of file inout.hh.

◆ name_

QString VSI::InOut::name_
private

Definition at line 90 of file inout.hh.

◆ shortDesc_

QString VSI::InOut::shortDesc_
private

Definition at line 91 of file inout.hh.

◆ type_

QString VSI::InOut::type_
private

Definition at line 94 of file inout.hh.


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