VISR  0.11.7
Versatile Interactive Scene Renderer
visr::pml::StringParameter Class Reference

#include <string_parameter.hpp>

Inheritance diagram for visr::pml::StringParameter:
visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) > visr::ParameterBase

Public Member Functions

 StringParameter (std::size_t maxLength=0)
 
 StringParameter (ParameterConfigBase const &config)
 
 StringParameter (EmptyParameterConfig const &config)
 
 StringParameter (std::string const &initStr)
 
virtual ~StringParameter () override
 
char const * str () const
 
std::size_t empty () const
 
std::size_t size () const
 
void assign (char const *newStr)
 
void assign (std::string const &newStr)
 
StringParameteroperator= (std::string const &newStr)
 
std::size_t maxLength () const
 
- Public Member Functions inherited from visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) >
 TypedParameterBase ()=default
 
virtual ~TypedParameterBase ()=default
 
ParameterType type () final
 
std::unique_ptr< ParameterBaseclone () const final
 
void assign (ParameterBase const &rhs) override
 
- Public Member Functions inherited from visr::ParameterBase
 ParameterBase ()
 
 ParameterBase (const ParameterBase &)
 
ParameterBaseoperator= (const ParameterBase &)
 
virtual ~ParameterBase ()
 

Additional Inherited Members

- Public Types inherited from visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) >
using ParameterConfigType = EmptyParameterConfig
 
- Static Public Member Functions inherited from visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) >
static const constexpr ParameterType staticType ()
 

Detailed Description

A type for passing strings between processing components.

Constructor & Destructor Documentation

◆ StringParameter() [1/4]

visr::pml::StringParameter::StringParameter ( std::size_t  maxLength = 0)
explicit

◆ StringParameter() [2/4]

visr::pml::StringParameter::StringParameter ( ParameterConfigBase const &  config)
explicit

◆ StringParameter() [3/4]

visr::pml::StringParameter::StringParameter ( EmptyParameterConfig const &  config)
explicit

◆ StringParameter() [4/4]

visr::pml::StringParameter::StringParameter ( std::string const &  initStr)
explicit
Note
Reconsider and possibly remove.

◆ ~StringParameter()

visr::pml::StringParameter::~StringParameter ( )
overridevirtualdefault

Member Function Documentation

◆ assign() [1/2]

void visr::pml::StringParameter::assign ( char const *  newStr)

◆ assign() [2/2]

void visr::pml::StringParameter::assign ( std::string const &  newStr)

◆ empty()

std::size_t visr::pml::StringParameter::empty ( ) const

◆ maxLength()

std::size_t visr::pml::StringParameter::maxLength ( ) const
inline

Return the maximum length.

◆ operator=()

StringParameter & visr::pml::StringParameter::operator= ( std::string const &  newStr)

◆ size()

std::size_t visr::pml::StringParameter::size ( ) const

◆ str()

char const * visr::pml::StringParameter::str ( ) const

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