OEStringParameter

Attention

This is a preliminary API until Fall 2021 and may be improved based on user feedback. It is currently available in C++ and Python.

class OEStringParameter : public OEPODParameter<std::string>

The OEStringParameter represents parameter that has string value.

Following methods are publicly inherited from OEParameter:

• AddAlias and GetAliases

• AddDetail and GetDetail

• AddIllegalRange and GetIllegalRanges

• AddIllegalValue and GetIllegalValues

• AddLegalRange and GetLegalRanges

• AddStringDefault , GetStringDefault and GetStringDefaults

• AddStringValue , GetStringValue and GetStringValues

• ClearDefaults

• ClearValues

• CreateCopy

• GetBrief and SetBrief

• GetHasDefault

• GetHasValue

• GetIsList and SetIsList

• GetKeyless and SetKeyless

• GetName and SetName

• GetOrderPriority and SetOrderPriority

• GetVisibility and SetVisibility

• IsLegalString

• IsSet and IsSetToString

Following methods are publicly inherited from OETypedParameter:

• AddDefault , GetDefault , GetDefaults and SetDefault

• GetSetting and GetSettings

• AddValue , GetValue , GetValues and SetValue

Following methods are publicly inherited from OEPODParameter:

• GetDefaultsVector

• GetSettingsVector

• GetValuesVector

The following classes derive from this class:

• OEMolReaderParameter

• OEMolWriterParameter

Constructors

OEStringParameter()
OEStringParameter(const std::string& name)
OEStringParameter(const std::string& name, const std::string& default)
OEStringParameter(const OEStringParameter&)

Default and copy constructors.

Constructs an OEStringParameter instance using the specified set of parameters.

operator=

OEStringParameter &operator=(const OEStringParameter &)

The assignment operator.