NDEVR
API Documentation
StringStream< DesignParameter >

Template specialization of StringStream for DesignParameter. More...

Inheritance diagram for StringStream< DesignParameter >:
[legend]
Collaboration diagram for StringStream< DesignParameter >:
[legend]

Static Public Member Functions

static void fromString (const StringView &string, DesignParameter &value)
 Logic for converting an object from an NDEVR API String allowing it to be used automatically with getAs<>(), Files, GenericOptions, and various other data structures.
static const char * getValidRegex ()
 Optionally specified to allow the software to do a check on user or file input to ensure that fromString will return a valid result or to limit user live input.
static void toDisplayString (const DesignParameter &value, TranslatedString &string)
 Logic for converting an object to an NDEVR API translated, user facing string.
static void toString (const DesignParameter &value, StringAllocatingView &string)
 Logic for converting an object to an NDEVR API String allowing it to be used automatically with the String constructor, GenericOptions, Scanners, and various other data structures.

Detailed Description

Template specialization of StringStream for DesignParameter.


Provides string serialization support for DesignParameter objects.

Definition at line 202 of file DesignParameter.h.

Member Function Documentation

◆ fromString()

void StringStream< DesignParameter >::fromString ( const StringView & string,
DesignParameter & value )
static

Logic for converting an object from an NDEVR API String allowing it to be used automatically with getAs<>(), Files, GenericOptions, and various other data structures.


◆ getValidRegex()

const char * StringStream< DesignParameter >::getValidRegex ( )
static

Optionally specified to allow the software to do a check on user or file input to ensure that fromString will return a valid result or to limit user live input.


◆ toDisplayString()

void StringStream< DesignParameter >::toDisplayString ( const DesignParameter & value,
TranslatedString & string )
static

Logic for converting an object to an NDEVR API translated, user facing string.


This allows the object to be shown in a unique way to a user. If not overwritten, will default to the value returned from toString

◆ toString()

void StringStream< DesignParameter >::toString ( const DesignParameter & value,
StringAllocatingView & string )
static

Logic for converting an object to an NDEVR API String allowing it to be used automatically with the String constructor, GenericOptions, Scanners, and various other data structures.



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