Class VariableUsageCreator
VariableUsage
.
It is used to create the 'VariableUsage' object step-by-step, i.e.
'VariableUsageCreator' objects are of intermediate state.- See Also:
-
VariableUsage
-
Field Summary
-
Constructor Summary
ConstructorDescriptionVariableUsageCreator
(String reference) VariableUsageCreator
(String reference, String... innerReferences) -
Method Summary
Modifier and TypeMethodDescriptionorg.palladiosimulator.pcm.parameter.VariableUsage
build()
Turns the entity in the making into the finished entity.Defines the unique name of this current entity.withNamespaceReference
(String reference, String... innerReferences) Creates aNamespaceReference
and adds it to the 'VariableUsage'.withVariableCharacterisation
(String specificationStochasticExpression, org.palladiosimulator.pcm.parameter.VariableCharacterisationType type) Creates aVariableCharacterisation
and adds it to the 'VariableUsage'.withVariableReference
(String reference) Creates aVariableReference
and adds it to the 'VariableUsage'.
-
Constructor Details
-
VariableUsageCreator
public VariableUsageCreator() -
VariableUsageCreator
-
VariableUsageCreator
-
-
Method Details
-
withName
Description copied from class:Entity
Defines the unique name of this current entity. Once created entities are referenced by this name. Only entities with a unique name can be fetched from the model. -
withVariableCharacterisation
public VariableUsageCreator withVariableCharacterisation(String specificationStochasticExpression, org.palladiosimulator.pcm.parameter.VariableCharacterisationType type) Creates aVariableCharacterisation
and adds it to the 'VariableUsage'.Variable characterizations store performance critical meta-information on a variable. For example, if a variable's value is used in a long running loop, the value of the variable is performance critical.
Variable characterizations contain atype
(VariableCharacterisationType
), which tells what kind of meta-information is stored and aPCMRandomVariable
for storing the value of the characterization.The stochastic Expression
specification_stochasticExpression
specifies the value of the characterization as a PCMRandomVariable. Possible values for thetype
are 'STRUCTURE', 'NUMBER_OF_ELEMENTS', 'BYTESIZE', 'TYPE', 'VALUE'.- Parameters:
specificationStochasticExpression
- value of the characterizationtype
- of the characterization- Returns:
- the variable usage in the making
- See Also:
-
VariableCharacterisation
VariableUsage
-
withVariableReference
Creates aVariableReference
and adds it to the 'VariableUsage'. A variable usage can have either a variable reference or a namespace reference that can contain inner references.The
reference
refers to the name of the characterized variable as a namedReference association.
Note that it was an explicit design decision to refer to variable names instead of the actual variables (i.e., by referring to Parameter class).- Parameters:
reference
- the name of the characterized variable- Returns:
- the variable usage in the making
- See Also:
-
AbstractNamedReference
-
withNamespaceReference
Creates aNamespaceReference
and adds it to the 'VariableUsage'. A variable usage can have either a variable reference or a namespace reference that can contain inner references.The
reference
refers to the namespace of the characterized variable. TheinnerReferences
are optional further namespace references, though the last innerRefernce will always be aVariableReference
. Combined they act as a namedReference association.
Note that it was an explicit design decision to refer to variable names instead of the actual variables (i.e., by referring to Parameter class).- Parameters:
reference
- namespace reference of the characterized variableinnerReferences
- further namespace references and a variable reference of the characterized variable- Returns:
- the variable usage in the making
- See Also:
-
AbstractNamedReference
-
build
public org.palladiosimulator.pcm.parameter.VariableUsage build()Description copied from class:Entity
Turns the entity in the making into the finished entity.
-