OEPredicateParameter

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.

template<class TT>
template <class TT>class OEPredicateParameter : public OESystem::OEPointerParameter<TT>

The OEPredicateParameter represents parameter that has value of predicate type.

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

The OEPredicateParameter class defines the following public methods:

• GetDefault and SetDefault

• GetSetting

• GetValue and SetValue

The following classes derive from this class:

• OEUnAtomPredParameter

• OEUnBondPredParameter

Constructors

OEPredicateParameter()
OEPredicateParameter(const std::string& name)
OEPredicateParameter(const OEPredicateParameter&)

Default and copy constructors.

Constructs an OEPredicateParameter instance using the specified set of parameters.

operator=

OEPredicateParameter &operator=(const OEPredicateParameter &)

The assignment operator.

GetDefault

TT* GetDefault() const

Returns the current default value of the parameter.

GetSetting

TT* GetSetting() const

Returns the current setting of the parameter.

GetValue

TT* GetValue() const

Returns the current user-defined value of the parameter.

SetDefault

bool SetDefault(const TT& value)

Sets the default value of the parameter.

SetValue

bool SetValue(const TT& value)

Sets the user-defined value of the parameter.