|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPCollaboration
The IRPCollaboration interface represents the capabilities included in sequence diagrams and communications diagrams. To get the IRPCollaboration object underlying a sequence diagram or a communication diagram, use the methods IRPSequenceDiagram.getLogicalCollaboration() and IRPCollaborationDiagram.getLogicalCollaboration().
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement |
---|
IRPModelElement.OSLCLink |
Method Summary | |
---|---|
IRPActionBlock |
addActionBlock(IRPClassifierRole classifier)
Adds a new action block to the specified classifier. |
IRPMessage |
addCancelledTimeout(IRPClassifierRole receiver)
Adds a cancelled timeout to the specified instance line. |
IRPClassifierRole |
addClassifierRole(java.lang.String newVal,
IRPClassifier cls)
Adds an instance line to a sequence diagram. |
IRPClassifierRole |
addClassifierRoleByName(java.lang.String newVal,
java.lang.String classFullPath)
method addClassifierRoleByName |
IRPClassifierRole |
addClassifierRoleForInstance(IRPInstance inst)
method addClassifierRoleForInstance |
IRPMessage |
addConditionMark(IRPClassifierRole classifier)
Adds a condition mark to the specified instance line. |
IRPMessage |
addCtor(IRPInterfaceItem interItem,
java.lang.String actualParamList,
IRPClassifierRole sender,
IRPClassifierRole receiver)
Adds a Create Arrow to a sequence diagram. |
IRPMessage |
addDataFlow(IRPSysMLPort flowPort,
java.lang.String value,
IRPClassifierRole sender,
IRPClassifierRole receiver)
method addDataFlow |
IRPMessage |
addDestructionEvent(IRPClassifierRole classifier)
Adds a destruction event to the specified lifeline. |
IRPMessage |
addDtor(IRPInterfaceItem interItem,
java.lang.String actualParamList,
IRPClassifierRole sender,
IRPClassifierRole receiver)
Adds a Destroy Arrow to a sequence diagram. |
IRPMessage |
addDurationConstraint(java.lang.String durationConstraint,
IRPMessage startState,
IRPMessage endState)
Adds a Duration Constraint to the specified state invariants. |
IRPMessage |
addDurationObservation(java.lang.String durationObservation,
IRPMessage startState,
IRPMessage endState)
Adds a Duration Observation to the specified states invariants. |
IRPMessage |
addFoundMessage(IRPClassifierRole receiver)
Adds a Found Message to the specified lifeline. |
IRPInteractionOccurrence |
addInteractionOccurrence()
Adds an interaction occurrence. |
IRPInteractionOperator |
addInteractionOperator()
Adds an interaction operator to a sequence diagram. |
IRPMessage |
addLostMessage(IRPClassifierRole sender)
Adds a Lost Message to the specified lifeline. |
IRPMessage |
addMessage(IRPInterfaceItem interItem,
java.lang.String actualParamList,
IRPClassifierRole sender,
IRPClassifierRole receiver)
Adds a message to a sequence diagram. |
IRPMessage |
addReplyMessage(IRPInterfaceItem interItem,
java.lang.String actualParamList,
IRPClassifierRole sender,
IRPClassifierRole receiver)
method addReplyMessage |
IRPMessage |
addStateInvariant(java.lang.String invariant,
IRPClassifierRole classifier)
Adds a State Invariant to the specified lifeline. |
IRPClassifierRole |
addSystemBorder()
Adds a System Border element to a sequence diagram. |
IRPMessage |
addTimeConstraint(java.lang.String timeConstraint,
IRPMessage state)
Adds a Time Constraint to the specified state invariant. |
IRPMessage |
addTimeInterval(IRPClassifierRole receiver)
Adds a Time Interval to the specified lifeline. |
IRPMessage |
addTimeObservation(java.lang.String timeObservation,
IRPMessage state)
Adds a Time Observation to the specified state invariant. |
IRPMessage |
addTimeout(IRPInterfaceItem interItem,
java.lang.String actualParamList,
IRPClassifierRole sender,
IRPClassifierRole receiver)
Adds a timeout to a sequence diagram. |
IRPSequenceDiagram |
generateSequence(java.lang.String newVal,
IRPPackage owner)
Generates a sequence diagram from the content of the IRPCollaboration object. |
java.lang.String |
getActivationCondition()
get property activationCondition |
java.lang.String |
getActivationMode()
get property activationMode |
IRPMessage |
getActivator(IRPMessage msg)
method getActivator |
IRPCollection |
getAssociations()
get property associations |
IRPCollection |
getClassifier()
Returns a collection of all the instance lines in the sequence diagram. |
IRPCollection |
getConcurrentGroup(IRPMessage msg)
method getConcurrentGroup |
IRPCollection |
getExecutionOccurrences()
Returns a collection of all the Execution Occurrences in the diagram. |
IRPCollection |
getInteractionOccurrences()
Returns a collection of all the interaction occurrences in the sequence diagram. |
IRPCollection |
getInteractionOperators()
Returns a collection of all the interaction operators in the sequence diagram. |
IRPCollection |
getMessagePoints()
Returns all the message points along the specified instance line. |
IRPCollection |
getMessagePoints(IRPClassifierRole classifier)
Returns all the message points along the specified instance line. |
IRPCollection |
getMessages()
Returns a collection of all the messages in the sequence diagram. |
java.lang.String |
getMode()
get property mode |
IRPMessage |
getPredecessor(IRPMessage msg)
Returns the message that precedes the specified message. |
IRPMessage |
getSuccessor(IRPMessage msg)
Returns the message that follows the specified message. |
Method Detail |
---|
IRPActionBlock addActionBlock(IRPClassifierRole classifier)
classifier
- the classifier to which the action block should be added
IRPMessage addCancelledTimeout(IRPClassifierRole receiver)
receiver
- the instance line that the cancelled timeout should be added to
IRPClassifierRole addClassifierRole(java.lang.String newVal, IRPClassifier cls)
newVal
- the name to use for the new instance linecls
- the class that the instance line is based on
IRPClassifierRole addClassifierRoleByName(java.lang.String newVal, java.lang.String classFullPath)
RhapsodyRuntimeException
IRPClassifierRole addClassifierRoleForInstance(IRPInstance inst)
RhapsodyRuntimeException
IRPMessage addConditionMark(IRPClassifierRole classifier)
classifier
- the instance line to which the condition mark should be added
IRPMessage addCtor(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
interItem
- the constructor for the object to be createdactualParamList
- string representing the arguments to pass to the constructor. The string provided should be a comma-separated list of argumentssender
- the instance line at which the Create Arrow beginsreceiver
- the instance line at which the Create Arrow ends (representing the object to be created)
IRPMessage addDataFlow(IRPSysMLPort flowPort, java.lang.String value, IRPClassifierRole sender, IRPClassifierRole receiver)
RhapsodyRuntimeException
IRPMessage addDestructionEvent(IRPClassifierRole classifier)
classifier
- the lifeline that the destruction event should be added to
IRPMessage addDtor(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
interItem
- the destructor for the object to be destroyedactualParamList
- since destructors do not take arguments, use an empty string "" for this parametersender
- the instance line at which the Destroy Arrow beginsreceiver
- the instance line at which the Destroy Arrow ends (representing the object to be destroyed)
IRPMessage addDurationConstraint(java.lang.String durationConstraint, IRPMessage startState, IRPMessage endState)
durationConstraint
- the text to display above the new Duration ConstraintstartState
- the state invariant at which the new Duration Constraint should beginendState
- the state invariant at which the new Duration Constraint should end. If you want the Duration Constraint to cover only a single state invariant, specify the same state invariant for both the startState parameter and the endState parameter
IRPMessage addDurationObservation(java.lang.String durationObservation, IRPMessage startState, IRPMessage endState)
durationObservation
- the text to display above the new Duration ObservationstartState
- the state invariant at which the new Duration Observation should beginendState
- the state invariant at which the new Duration Observation should end. If you want the Duration Observation to cover only a single state invariant, specify the same state invariant for both the startState parameter and the endState parameter
IRPMessage addFoundMessage(IRPClassifierRole receiver)
receiver
- the lifeline that the Found Message should be added to
IRPInteractionOccurrence addInteractionOccurrence()
IRPInteractionOperator addInteractionOperator()
IRPMessage addLostMessage(IRPClassifierRole sender)
sender
- the lifeline that the Lost Message should be added to
IRPMessage addMessage(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
interItem
- the operation call represented by the messageactualParamList
- the arguments to pass to the operation. If the operation does not take any arguments, use an empty string "" for this parametersender
- the instance line sending the messagereceiver
- the instance line receiving the message
IRPMessage addReplyMessage(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
RhapsodyRuntimeException
IRPMessage addStateInvariant(java.lang.String invariant, IRPClassifierRole classifier)
invariant
- the text to use for the Invariant field of the new State Invariantclassifier
- the lifeline that the State Invariant should be added to
IRPClassifierRole addSystemBorder()
IRPMessage addTimeConstraint(java.lang.String timeConstraint, IRPMessage state)
timeConstraint
- the text to display for the new Time Constraintstate
- the state invariant to which the new Time Constraint should be added
IRPMessage addTimeInterval(IRPClassifierRole receiver)
receiver
- the lifeline that the Time Interval should be added to
IRPMessage addTimeObservation(java.lang.String timeObservation, IRPMessage state)
timeObservation
- the text to display for the new Time Observationstate
- the state invariant to which the new Time Observation should be added
IRPMessage addTimeout(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
interItem
- use null for this parameteractualParamList
- duration of timeout in millisecondssender
- the instance line that the timeout should be added toreceiver
- use null for this parameter
IRPSequenceDiagram generateSequence(java.lang.String newVal, IRPPackage owner)
newVal
- the name to give to the new diagramowner
- the package to which the new diagram should belong
java.lang.String getActivationCondition()
RhapsodyRuntimeException
java.lang.String getActivationMode()
RhapsodyRuntimeException
IRPMessage getActivator(IRPMessage msg)
RhapsodyRuntimeException
IRPCollection getAssociations()
RhapsodyRuntimeException
IRPCollection getClassifier()
IRPCollection getConcurrentGroup(IRPMessage msg)
RhapsodyRuntimeException
IRPCollection getExecutionOccurrences()
IRPCollection getInteractionOccurrences()
IRPCollection getInteractionOperators()
IRPCollection getMessagePoints(IRPClassifierRole classifier)
IRPCollection getMessagePoints()
IRPCollection getMessages()
java.lang.String getMode()
RhapsodyRuntimeException
IRPMessage getPredecessor(IRPMessage msg)
msg
- the message whose predecessor has to be found
IRPMessage getSuccessor(IRPMessage msg)
msg
- the message whose successor has to be found
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |