SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
python.uq.parameters.Parameter.Parameter Class Reference
Inheritance diagram for python.uq.parameters.Parameter.Parameter:

Public Member Functions

 __init__ (self, name)
 
 fromJson (cls, jsonObject)
 
 getCount (self)
 
 getName (self)
 
 getProbabilisticValue (self)
 
 getTransformation (self)
 
 getUnitValue (self)
 
 hasValue (self, value)
 
 isActive (self)
 
 isUncertain (self)
 
 setName (self, name)
 
 toJson (self)
 

Protected Attributes

 _name
 
 _trans
 
 _value
 

Detailed Description

Super-class for parameters

Constructor & Destructor Documentation

◆ __init__()

python.uq.parameters.Parameter.Parameter.__init__ (   self,
  name 
)

Member Function Documentation

◆ fromJson()

python.uq.parameters.Parameter.Parameter.fromJson (   cls,
  jsonObject 
) 
Restores the Parameter object from the json object
with its attributes.
@param jsonObject: json object
@return: the restored Parameter object

Referenced by python.learner.Learner.Learner.setMemento(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.setMemento(), python.uq.learner.Learner.Learner.setMemento(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.setMemento(), and python.uq.uq_setting.UQSetting.UQSetting.setMemento().

◆ getCount()

python.uq.parameters.Parameter.Parameter.getCount (   self)

◆ getName()

python.uq.parameters.Parameter.Parameter.getName (   self)

References python.uq.parameters.DeterministicParameter.DeterministicParameter._name, python.uq.parameters.Parameter.Parameter._name, python.uq.parameters.ParameterDescriptor.ParameterDescriptor._name, python.uq.parameters.ParameterDescriptor.DeterministicParameterDescriptor._name, python.uq.parameters.ParameterDescriptor.UncertainParameterDesciptor._name, and python.uq.parameters.UncertainParameter.UncertainParameter._name.

◆ getProbabilisticValue()

python.uq.parameters.Parameter.Parameter.getProbabilisticValue (   self)

References python.uq.parameters.DeterministicParameter.DeterministicParameter._value, python.uq.parameters.Parameter.Parameter._value, python.uq.parameters.ParameterDescriptor.ParameterDescriptor._value, python.uq.parameters.ParameterDescriptor.DeterministicParameterDescriptor._value, python.uq.parameters.ParameterDescriptor.UncertainParameterDesciptor._value, and python.uq.parameters.UncertainParameter.UncertainParameter._value.

◆ getTransformation()

python.uq.parameters.Parameter.Parameter.getTransformation (   self)

References python.uq.parameters.DeterministicParameter.DeterministicParameter._trans, python.uq.parameters.Parameter.Parameter._trans, and python.uq.parameters.UncertainParameter.UncertainParameter._trans.

◆ getUnitValue()

python.uq.parameters.Parameter.Parameter.getUnitValue (   self)

References python.uq.parameters.DeterministicParameter.DeterministicParameter._trans, python.uq.parameters.Parameter.Parameter._trans, python.uq.parameters.UncertainParameter.UncertainParameter._trans, python.uq.parameters.DeterministicParameter.DeterministicParameter._value, python.uq.parameters.Parameter.Parameter._value, python.uq.parameters.ParameterDescriptor.ParameterDescriptor._value, python.uq.parameters.ParameterDescriptor.DeterministicParameterDescriptor._value, python.uq.parameters.ParameterDescriptor.UncertainParameterDesciptor._value, and python.uq.parameters.UncertainParameter.UncertainParameter._value.

◆ hasValue()

python.uq.parameters.Parameter.Parameter.hasValue (   self,
  value 
)

References python.uq.parameters.DeterministicParameter.DeterministicParameter._value, python.uq.parameters.Parameter.Parameter._value, python.uq.parameters.ParameterDescriptor.ParameterDescriptor._value, python.uq.parameters.ParameterDescriptor.DeterministicParameterDescriptor._value, python.uq.parameters.ParameterDescriptor.UncertainParameterDesciptor._value, and python.uq.parameters.UncertainParameter.UncertainParameter._value.

Referenced by python.uq.quadrature.bilinearform.BilinearQuadratureStrategy.BilinearQuadratureStrategy.getBilinearFormEntry(), python.uq.quadrature.linearform.LinearQuadratureStrategy.LinearQuadratureStrategy.getLinearFormEntry(), and python.uq.quadrature.trilinearform.TrilinearQuadratureStrategy.TrilinearQuadratureStrategy.getTrilinearFormEntry().

◆ isActive()

python.uq.parameters.Parameter.Parameter.isActive (   self)

References python.uq.parameters.DeterministicParameter.DeterministicParameter.isUncertain(), python.uq.parameters.Parameter.Parameter.isUncertain(), and python.uq.parameters.UncertainParameter.UncertainParameter.isUncertain().

Referenced by python.uq.parameters.UncertainParameter.UncertainParameter.__str__().

◆ isUncertain()

python.uq.parameters.Parameter.Parameter.isUncertain (   self)

Referenced by python.uq.parameters.Parameter.Parameter.isActive(), and python.uq.parameters.Parameter.Parameter.toJson().

◆ setName()

python.uq.parameters.Parameter.Parameter.setName (   self,
  name 
)

References python.uq.parameters.DeterministicParameter.DeterministicParameter._name, python.uq.parameters.Parameter.Parameter._name, python.uq.parameters.ParameterDescriptor.ParameterDescriptor._name, python.uq.parameters.ParameterDescriptor.DeterministicParameterDescriptor._name, python.uq.parameters.ParameterDescriptor.UncertainParameterDesciptor._name, and python.uq.parameters.UncertainParameter.UncertainParameter._name.

◆ toJson()

python.uq.parameters.Parameter.Parameter.toJson (   self) 
Returns a string that represents the object

References python.uq.parameters.DeterministicParameter.DeterministicParameter.isUncertain(), python.uq.parameters.Parameter.Parameter.isUncertain(), and python.uq.parameters.UncertainParameter.UncertainParameter.isUncertain().

Referenced by python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__str__(), python.uq.uq_setting.UQSetting.UQSetting.__str__(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.createMemento(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.createMemento(), and python.uq.uq_setting.UQSetting.UQSetting.createMemento().

Member Data Documentation

◆ _name

python.uq.parameters.Parameter.Parameter._name
protected

Referenced by python.uq.parameters.Parameter.Parameter.getName(), python.uq.parameters.ParameterDescriptor.ParameterDescriptor.isCalled(), and python.uq.parameters.Parameter.Parameter.setName().

◆ _trans

python.uq.parameters.Parameter.Parameter._trans
protected

Referenced by python.uq.parameters.Parameter.Parameter.getTransformation(), python.uq.parameters.UncertainParameter.UncertainParameter.getTransformation(), and python.uq.parameters.Parameter.Parameter.getUnitValue().

◆ _value

python.uq.parameters.Parameter.Parameter._value
protected

Referenced by python.uq.parameters.ParameterDescriptor.DeterministicParameterDescriptor.andGetResult(), python.uq.parameters.Parameter.Parameter.getProbabilisticValue(), python.uq.parameters.DeterministicParameter.DeterministicParameter.getSample(), python.uq.parameters.Parameter.Parameter.getUnitValue(), python.uq.parameters.Parameter.Parameter.hasValue(), python.uq.parameters.ParameterDescriptor.ParameterDescriptor.hasValue(), and python.uq.parameters.UncertainParameter.UncertainParameter.isActive().

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