OEChargeParameter

Attention

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

class OEChargeParameter : public OESystem::OEMultiParameter<OEProton::OEChargeEngineBase>

The OEChargeParameter represents parameter that has a value of type OEChargeEngineBase.

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 OEMultiParameter:

• AddLegalEntry

• GetDefault and SetDefault

• GetSetting

• GetValue and SetValue

Constructors

OEChargeParameter()
OEChargeParameter(const std::string& name, const bool customAllowed)
OEChargeParameter(const OEChargeParameter&)

Default and copy constructors.

Constructs an OEChargeParameter instance using the specified set of parameters. The second argument in the second constructor represents if a custom forcefield can be used.

operator=

OEChargeParameter &operator=(const OEChargeParameter &)

The assignment operator.