Package org.palladiosimulator.generator.fluent.usagemodel.structure.components.actions

Class EntryLevelSystemCallCreator

  • public class EntryLevelSystemCallCreator
extends ActionCreator
    This class constructs a EntryLevelSystemCall. It is used to create the 'EntryLevelSystemCall' object step-by-step, i.e. 'EntryLevelSystemCallCreator' objects are of intermediate state.
    See Also:
    EntryLevelSystemCall, AbstractUserAction

    • Constructor Detail

      • EntryLevelSystemCallCreator

        public EntryLevelSystemCallCreator​(org.palladiosimulator.pcm.repository.OperationSignature operationSignature,
                                   org.palladiosimulator.pcm.repository.OperationProvidedRole operationProvidedRole)
        Instantiates a new entry level system call creator.

        An EntryLevelSystemCall models the call to a service provided by a system. Therefore, anEntryLevelSystemCall references a ProvidedRole of a PCM System, from which the called interface and the providing component within the system can be derived, and a Signature specifying the called service. Notice, that the usage model does not permit the domain expert to model calls directly to components, but only to system roles. This decouples the System structure(i.e., the component-based software architecture model and its allocation) from the UsageModeland the software architect can change the System (e.g., include new components, remove existing components, or change their wiring or allocation) independently from the domain expert, if the system provided roles are not affected. EntryLevelSystemCalls may include a set of input parameter characterisations and a set of output parameter characterisations (as described in the pcm::parameters package). However, the random variables characterising the input parameters like NUMBER_OF_ELEMENTS can not depend on other variables in the usage model. They have to be composed from literals only including literals describing random variables having a certain fixed distribution.

        Parameters:
        operationSignature - the operation signature
        operationProvidedRole - the operation provided role
        See Also:
        EntryLevelSystemCall, AbstractUserAction, OperationProvidedRole, OperationSignature

    • Method Detail

      • withPriority

        public EntryLevelSystemCallCreator withPriority​(int priority)
        Adds an priority to the Entry Level System Call.
        Parameters:
        priority - the priority
        Returns:
        the current entry level system call in the making

      • addToEntryLevelSystemCallOutput

        public EntryLevelSystemCallCreator addToEntryLevelSystemCallOutput​(VariableUsageCreator outputParameterUsage)
        Adds an Output Parameter to the entry level system call.

        Create a new variable usage by using the org.palladiosimulator.generator.fluent.usagemodel.factory, i.e. create.newVariableUsage(String variableReference) orcreate.newVariableUsage(String namespaceReference, String... innerReferences).

        Parameters:
        outputParameterUsage - variable usage in the making
        Returns:
        the entry level system call in the making
        See Also:
        VariableUsage

      • addToEntryLevelSystemCallInput

        public EntryLevelSystemCallCreator addToEntryLevelSystemCallInput​(VariableUsageCreator inputParameterUsage)
        Adds an Input Parameter to the entry level system call.

        Create a new variable usage by using the org.palladiosimulator.generator.fluent.usagemodel.factory, i.e. create.newVariableUsage(String variableReference) orcreate.newVariableUsage(String namespaceReference, String... innerReferences).

        Parameters:
        inputParameterUsage - variable usage in the making
        Returns:
        the entry level system call in the making
        See Also:
        VariableUsage

      • build

        public org.palladiosimulator.pcm.usagemodel.EntryLevelSystemCall build()
        Description copied from class: Entity
        Turns the entity in the making into the finished entity.
        Specified by:
        build in class ActionCreator
        Returns:
        the finished entity

      • withSuccessor

        public EntryLevelSystemCallCreator withSuccessor​(ActionCreator action)
        Description copied from class: ActionCreator
        Adds an Abstract User Action as successor.

        Create a new action by using the org.palladiosimulator.generator.fluent.usagemodel.factory, i.e. create.newBranchAction().

        Overrides:
        withSuccessor in class ActionCreator
        Parameters:
        action - in the making
        Returns:
        the current action in the making
        See Also:
        AbstractUserAction

      • withName

        public EntryLevelSystemCallCreator withName​(String name)
        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.
        Overrides:
        withName in class ActionCreator
        Returns:
        this current entity in the making