OEFileStringParameter

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 OEFileStringParameter : public OESystem::OEStringParameter

The OEFileStringParameter represents parameter that has string value representing a readable file format for modeling objects, such as a molecule or a design unit.

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

Constructors

OEFileStringParameter()
OEFileStringParameter(const std::string& name, const unsigned fileType)
OEFileStringParameter(const OEFileStringParameter&)

Default and copy constructors.

Constructs an OEFileStringParameter instance using the specified set of parameters. The fileType refers to a constants defined in the OEFileStringType namespace.

operator=

OEFileStringParameter &operator=(const OEFileStringParameter &)

The assignment operator.