View on GitHub

Vistle

Distributed Data-parallel Scientific Visualization in VR

Public Types | Public Member Functions | Friends | List of all members
vistle::ParameterBase< T > Class Template Reference

#include <core/parameter.h>

Inheritance diagram for vistle::ParameterBase< T >:
Inheritance graph
[legend]
Collaboration diagram for vistle::ParameterBase< T >:
Collaboration graph
[legend]

Public Types

typedef T ValueType
 

Public Member Functions

 ParameterBase (int moduleId, const std::string &name, T value=T())
 
 ParameterBase (const ParameterBase< T > &other)
 
virtual ~ParameterBase ()
 
virtual ParameterBase< T > * clone () const
 
bool isDefault () const
 
const T getDefaultValue () const
 
const T getValue () const
 
const T getValue (RangeType rt) const
 
virtual bool checkValue (const T &value) const
 
virtual bool checkChoice (const std::vector< std::string > &ch) const
 
virtual T minimum () const
 
virtual T maximum () const
 
 operator std::string () const
 
- Public Member Functions inherited from vistle::Parameter
 DEFINE_ENUM_WITH_STRING_CONVERSIONS (Type,(Unknown)(Float)(Integer)(Vector)(IntVector)(String)(Invalid)) DEFINE_ENUM_WITH_STRING_CONVERSIONS(Presentation
 
 Generic (Filename)(ExistingFilename)(Directory)(ExistingDirectory)(NewPathname)(Boolean)(Choice)(Slider)(Color)(InvalidPresentation)) DEFINE_ENUM_WITH_STRING_CONVERSIONS(RangeType
 
Minimum() Value (Maximum)) Parameter(int moduleId
 
 Parameter (const Parameter &other)
 
virtual ~Parameter ()
 
void setPresentation (Presentation presentation)
 
void setDescription (const std::string &description)
 
void setChoices (const std::vector< std::string > &choices)
 
void setGroup (const std::string &group)
 
const std::string & group () const
 
int module () const
 
const std::string & getName () const
 
Type type () const
 
Presentation presentation () const
 
const std::string & description () const
 
const std::vector< std::string > & choices () const
 

Friends

class ParameterManager
 
class Module
 
class Renderer
 
class message::SetParameter
 
class VistleConnection
 
class gui::Parameters
 
class ::VistleInteractor
 

Additional Inherited Members

- Public Attributes inherited from vistle::Parameter
Minimum() const std::string & name
 
Minimum() const std::string Type = Invalid
 
Minimum() const std::string Presentation = Generic)
 
- Protected Attributes inherited from vistle::Parameter
std::vector< std::string > m_choices
 

Member Typedef Documentation

◆ ValueType

template<typename T >
typedef T vistle::ParameterBase< T >::ValueType

Constructor & Destructor Documentation

◆ ParameterBase() [1/2]

template<typename T >
vistle::ParameterBase< T >::ParameterBase ( int  moduleId,
const std::string &  name,
T  value = T() 
)
inline

◆ ParameterBase() [2/2]

template<typename T >
vistle::ParameterBase< T >::ParameterBase ( const ParameterBase< T > &  other)
inline

◆ ~ParameterBase()

template<typename T >
virtual vistle::ParameterBase< T >::~ParameterBase ( )
inlinevirtual

Member Function Documentation

◆ checkChoice()

template<typename T >
virtual bool vistle::ParameterBase< T >::checkChoice ( const std::vector< std::string > &  ch) const
inlinevirtual

Reimplemented from vistle::Parameter.

◆ checkValue()

template<typename T >
virtual bool vistle::ParameterBase< T >::checkValue ( const T &  value) const
inlinevirtual

◆ clone()

template<typename T >
virtual ParameterBase< T > * vistle::ParameterBase< T >::clone ( ) const
inlinevirtual

Implements vistle::Parameter.

◆ getDefaultValue()

template<typename T >
const T vistle::ParameterBase< T >::getDefaultValue ( ) const
inline

◆ getValue() [1/2]

template<typename T >
const T vistle::ParameterBase< T >::getValue ( ) const
inline

◆ getValue() [2/2]

template<typename T >
const T vistle::ParameterBase< T >::getValue ( RangeType  rt) const
inline

◆ isDefault()

template<typename T >
bool vistle::ParameterBase< T >::isDefault ( ) const
inlinevirtual

Implements vistle::Parameter.

◆ maximum()

template<typename T >
virtual T vistle::ParameterBase< T >::maximum ( ) const
inlinevirtual

◆ minimum()

template<typename T >
virtual T vistle::ParameterBase< T >::minimum ( ) const
inlinevirtual

◆ operator std::string()

template<typename T >
vistle::ParameterBase< T >::operator std::string ( ) const
inlinevirtual

Implements vistle::Parameter.

Friends And Related Function Documentation

◆ ::VistleInteractor

template<typename T >
friend class ::VistleInteractor
friend

◆ gui::Parameters

template<typename T >
friend class gui::Parameters
friend

◆ message::SetParameter

template<typename T >
friend class message::SetParameter
friend

◆ Module

template<typename T >
friend class Module
friend

◆ ParameterManager

template<typename T >
friend class ParameterManager
friend

◆ Renderer

template<typename T >
friend class Renderer
friend

◆ VistleConnection

template<typename T >
friend class VistleConnection
friend
The documentation for this class was generated from the following file: