UmlSequenceDiagramMessage Class Reference

List of all members.

Public Member Functions

 setText ($strText)
 getText ()
 setMethod ($strMethod)
 getMethod ()
 setType ($strType)
 getType ()
 getPosition ()
 setPosition ($intPosition)
 setActorFrom (UmlSequenceDiagramActor $objActor)
 getActorFrom ()
 setActorTo (UmlSequenceDiagramActor $objActor)
 getActorTo ()
 setUmlSequenceDiagram (UmlSequenceDiagram $objUmlSequenceDiagram)
 getUmlSequenceDiagram ()
 setValues (Array $arrValues)
 getValues ()
 addValue (UmlSequenceDiagramValue $objValue)
 addNoteBefore (UmlSequenceDiagramNote $objNote)
 setNotesBefore (array $arrNotesBefore)
 getNotesBefore ()
 addNoteAfter (UmlSequenceDiagramNote $objNote)
 setNotesAfter (array $arrNotesAfter)
 getNotesAfter ()
 setTimeStart ($intTime)
 getTimeStart ()
 setTimeEnd ($intTime)
 getTimeEnd ()
 getTimeDuration ()
 isReverse ()
 isLarge ()
 isRecursive ()

Protected Attributes

 $strText = null
 $strMethod = null
 $strType = null
 $objActorFrom = null
 $objActorTo = null
 $arrValues = Array()
 $intTimeStart
 $intTimeEnd
 $intPosition
 $objUmlSequenceDiagram
 $arrNotesBefore = array()
 $arrNotesAfter = array()

Detailed Description

Message send between actors into the UmlSequenceDiagram object as the Sequence Diagram UML guidelines append of more attributes as the code context make usefull
Author:
Thiago Henrique Ramos da Mata <thiago.henrique.mata@gmail.com>

Definition at line 13 of file UmlSequenceDiagramMessage.class.php.

Member Function Documentation

addNoteAfter ( UmlSequenceDiagramNote $  objNote  ) 

Add a note after the message

Parameters:
UmlSequenceDiagramNote $objNote
Returns:
UmlSequenceDiagramMessage me

Definition at line 385 of file UmlSequenceDiagramMessage.class.php.

Referenced by setNotesAfter().

00386     {
00387         $this->arrNotesAfter[] = $objNote;
00388         return $this;
00389     }

addNoteBefore ( UmlSequenceDiagramNote $  objNote  ) 

Add a note before the message

Parameters:
UmlSequenceDiagramNote $objNote
Returns:
UmlSequenceDiagramMessage me

Definition at line 347 of file UmlSequenceDiagramMessage.class.php.

Referenced by setNotesBefore().

00348     {
00349         $this->arrNotesBefore[] = $objNote;
00350         return $this;
00351     }

addValue ( UmlSequenceDiagramValue $  objValue  ) 

Append one UmlSequenceDiagramValue into the collection of Values of the message

See also:
UmlSequenceDiagramMessage::setValues( UmlSequenceDiagramValue[] )

UmlSequenceDiagramMessage->arrValues

UmlSequenceDiagramMessage::getValues()

UmlSequenceDiagramValue

Parameters:
UmlSequenceDiagramValue $objValue
Returns:
UmlSequenceDiagramMessage me

Definition at line 335 of file UmlSequenceDiagramMessage.class.php.

00336     {
00337         $this->arrValues[] = $objValue;
00338         return $this;
00339     }

getActorFrom (  ) 

Returns the actor who is the recipient of the message

See also:
UmlSequenceDiagramMessage::setActorFrom( UmlSequenceDiagramActor )

UmlSequenceDiagramMessage->objActorFrom

UmlSequenceDiagramActor

Returns:
UmlSequenceDiagramActor

Definition at line 234 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage(), and UmlSequenceDiagramPrinterToHtml::getMessageValues().

00235     {
00236         return $this->objActorFrom;
00237     }

getActorTo (  ) 

Returns the actor who is the author of the message

See also:
UmlSequenceDiagramMessage::setActorTo( UmlSequenceDiagramActor )

UmlSequenceDiagramMessage->objActorTo

UmlSequenceDiagramActor

Returns:
UmlSequenceDiagramActor

Definition at line 262 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage(), UmlSequenceDiagramPrinterToHtml::getMessageText(), and UmlSequenceDiagramPrinterToHtml::getMessageValues().

00263     {
00264         return $this->objActorTo;
00265     }

getMethod (  ) 

Get the Method of the message

See also:
UmlSequenceDiagramMessage::setMethod( string )

UmlSequenceDiagramMessage->strMethod

Returns:
string

Definition at line 151 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessageText().

00152     {
00153         return $this->strMethod;
00154     }

getNotesAfter (  ) 

Get the notes what should be placed after the message

Returns:
UmlSequenceDiagramNote[]

Definition at line 411 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage().

00412     {
00413         return $this->arrNotesAfter;
00414     }

getNotesBefore (  ) 

Get the notes what should be placed before the message

Returns:
UmlSequenceDiagramNote[]

Definition at line 373 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage().

00374     {
00375         return $this->arrNotesBefore;
00376     }

getPosition (  ) 

Get the position of the message

See also:
UmlSequenceDiagramMessage::setPosition( integer )

UmlSequenceDiagramMessage->intPosition

Returns:
integer

Definition at line 193 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage(), and UmlSequenceDiagramPrinterToHtml::getMessageValues().

00194     {
00195         return $this->intPosition;
00196     }

getText (  ) 

Get the text of the message

See also:
UmlSequenceDiagramMessage::setText( string )

UmlSequenceDiagramMessage->strText

Returns:
string

Definition at line 125 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessageText(), and UmlSequenceDiagramPrinterToHtml::getMessageValues().

00126     {
00127         return $this->strText;
00128     }

getTimeDuration (  ) 

Return the duration in timestamp betwenn the start end end of the message

Returns:
integer

Definition at line 474 of file UmlSequenceDiagramMessage.class.php.

00475     {
00476         return $this->intTimeEnd - $this->intTimeStart;
00477     }

getTimeEnd (  ) 

Get the timestamp when the message ends

See also:
UmlSequenceDiagramMessage->intTimeEnd

UmlSequenceDiagramMessage::setTimeEnd( integer )

Returns:
integer

Definition at line 463 of file UmlSequenceDiagramMessage.class.php.

00464     {
00465         return $this->intTimeEnd;
00466     }

getTimeStart (  ) 

Get the timestamp when the message started

See also:
UmlSequenceDiagramMessage->intTimeStart

UmlSequenceDiagramMessage::setTimeStart( integer )

Returns:
integer

Definition at line 437 of file UmlSequenceDiagramMessage.class.php.

00438     {
00439         return $this->intTimeStart;
00440     }

getType (  ) 

Get the type of the message

See also:
UmlSequenceDiagramMessage::setType( string )

UmlSequenceDiagramMessage->strType

Returns:
string

Definition at line 181 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage(), UmlSequenceDiagramPrinterToHtml::getMessageText(), UmlSequenceDiagramPrinterToHtml::getMessageValues(), and UmlSequenceDiagramPrinterToHtml::getValue().

00182     {
00183         return $this->strType;
00184     }

getUmlSequenceDiagram (  ) 

Returns the uml sequence diagram parent of the message

See also:
UmlSequenceDiagramMessage::setUmlSequenceDiagram( UmlSequenceDiagram )

UmlSequenceDiagramMessage->objUmlSequenceDiagram

UmlSequenceDiagram

Returns:
UmlSequenceDiagram

Definition at line 291 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage().

00292     {
00293         return $this->objUmlSequenceDiagram;
00294     }

getValues (  ) 

Get the array of values of the message

See also:
UmlSequenceDiagramMessage::setValues( UmlSequenceDiagramValue[] )

UmlSequenceDiagramMessage->arrValues

UmlSequenceDiagramValue

Returns:
UmlSequenceDiagramValue[]

Definition at line 319 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessageValues(), and UmlSequenceDiagramPrinterToHtml::getValues().

00320     {
00321         return $this->arrValues;
00322     }

isLarge (  ) 

Returns true if the distance between the actor from and the actor to be bigger then 1, false otherwise

Returns:
boolean

Definition at line 498 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage().

00499     {
00500         return ( abs( $this->objActorFrom->getPosition() - $this->objActorTo->getPosition() ) > 1 );
00501     }

isRecursive (  ) 

Returns true if the actor from it is the actor to, false otherwise

Returns:
boolean

Definition at line 509 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage().

00510     {
00511         return( $this->objActorFrom->getPosition() == $this->objActorTo->getPosition() );
00512     }

isReverse (  ) 

Returns true if the position of the actor from is bigger then the position of the actor to, false otherwise

Returns:
boolean

Definition at line 486 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getMessage().

00487     {
00488         return ( $this->objActorFrom->getPosition() > $this->objActorTo->getPosition() );
00489     }

setActorFrom ( UmlSequenceDiagramActor $  objActor  ) 

Inform the actor who is the recipient of the message

See also:
UmlSequenceDiagramMessage::getActorFrom()

UmlSequenceDiagramMessage->objActorFrom

UmlSequenceDiagramActor

Parameters:
UmlSequenceDiagramActor $objActor
Returns:
UmlSequenceDiagramMessage me

Definition at line 220 of file UmlSequenceDiagramMessage.class.php.

00221     {
00222         $this->objActorFrom = $objActor;
00223         return $this;
00224     }

setActorTo ( UmlSequenceDiagramActor $  objActor  ) 

Inform the actor who is the author of the message

See also:
UmlSequenceDiagramMessage::getActorTo()

UmlSequenceDiagramMessage->objActorTo

UmlSequenceDiagramActor

Parameters:
UmlSequenceDiagramActor $objActor
Returns:
UmlSequenceDiagramMessage me

Definition at line 248 of file UmlSequenceDiagramMessage.class.php.

00249     {
00250         $this->objActorTo = $objActor;
00251         return $this;
00252     }

setMethod ( $  strMethod  ) 

Set the Method of the message

See also:
UmlSequenceDiagramMessage::getMethod()

UmlSequenceDiagramMessage->strMethod

Parameters:
string $strMethod
Returns:
UmlSequenceDiagramMessage me

Definition at line 138 of file UmlSequenceDiagramMessage.class.php.

References $strMethod.

00139     {
00140         $this->strMethod = $strMethod;
00141         return $this;
00142     }

setNotesAfter ( array $  arrNotesAfter  ) 

Set the notes what should be placed after the message

Parameters:
array $arrNotesAfter
Returns:
UmlSequenceDiagramMessage me

Definition at line 397 of file UmlSequenceDiagramMessage.class.php.

References addNoteAfter().

00398     {
00399         foreach( $arrNotesAfter as $objNote )
00400         {
00401             $this->addNoteAfter( $objNote );
00402         }
00403         return $this;
00404     }

setNotesBefore ( array $  arrNotesBefore  ) 

Set the notes what should be placed before the message

Parameters:
array $arrNotesBefore
Returns:
UmlSequenceDiagramMessage me

Definition at line 359 of file UmlSequenceDiagramMessage.class.php.

References addNoteBefore().

00360     {
00361         foreach( $arrNotesBefore as $objNote )
00362         {
00363             $this->addNoteBefore( $objNote );
00364         }
00365         return $this;
00366     }

setPosition ( $  intPosition  ) 

Set the position of the message

See also:
UmlSequenceDiagramMessage::getPosition()

UmlSequenceDiagramMessage->intPosition

Returns:
UmlSequenceDiagramMessage

Definition at line 205 of file UmlSequenceDiagramMessage.class.php.

References $intPosition.

Referenced by UmlSequenceDiagram::addMessage().

00206     {
00207         $this->intPosition = $intPosition;
00208         return $this;
00209     }

setText ( $  strText  ) 

Set the text of the message

See also:
UmlSequenceDiagramMessage::getText()

UmlSequenceDiagramMessage->strText

Parameters:
string $strText
Returns:
UmlSequenceDiagramMessage me

Definition at line 112 of file UmlSequenceDiagramMessage.class.php.

References $strText.

00113     {
00114         $this->strText = $strText;
00115         return $this;
00116     }

setTimeEnd ( $  intTime  ) 

Set the timestamp when the message ends

See also:
UmlSequenceDiagramMessage->intTimeEnds

UmlSequenceDiagramMessage::getTimeEnds()

Parameters:
integer $intTime
Returns:
UmlSequenceDiagramMessage

Definition at line 450 of file UmlSequenceDiagramMessage.class.php.

00451     {
00452         $this->intTimeEnd = $intTime;
00453         return $this;
00454     }

setTimeStart ( $  intTime  ) 

Set the timestamp when the message started

See also:
UmlSequenceDiagramMessage->intTimeStart

UmlSequenceDiagramMessage::getTimeStart()

Parameters:
integer $intTime
Returns:
UmlSequenceDiagramMessage

Definition at line 424 of file UmlSequenceDiagramMessage.class.php.

00425     {
00426         $this->intTimeStart = $intTime;
00427         return $this;
00428     }

setType ( $  strType  ) 

Set the type of the message

See also:
UmlSequenceDiagramMessage::getType()

UmlSequenceDiagramMessage->strType

Parameters:
string $strType
Returns:
UmlSequenceDiagramMessage me

Definition at line 164 of file UmlSequenceDiagramMessage.class.php.

References $strType.

00165     {
00166         if( !in_array( $strType, Array( 'call' , 'return' ) ) )
00167         {
00168             throw new Exception( "Invalid type of message " . $strType );
00169         }
00170         $this->strType = $strType;
00171         return $this;
00172     }

setUmlSequenceDiagram ( UmlSequenceDiagram $  objUmlSequenceDiagram  ) 

Inform the uml sequence diagram parent of the message

See also:
UmlSequenceDiagramMessage::getUmlSequenceDiagram()

UmlSequenceDiagramMessage->objUmlSequenceDiagram

UmlSequenceDiagram

Parameters:
UmlSequenceDiagram $objUmlSequenceDiagram
Returns:
UmlSequenceDiagramMessage me

Definition at line 277 of file UmlSequenceDiagramMessage.class.php.

Referenced by UmlSequenceDiagram::addMessage().

00278     {
00279         $this->objUmlSequenceDiagram = $objUmlSequenceDiagram;
00280         return $this;
00281     }

setValues ( Array $  arrValues  ) 

Set the array of values of the message

See also:
UmlSequenceDiagramMessage::getValues()

UmlSequenceDiagramMessage->arrValues

UmlSequenceDiagramValue

Parameters:
UmlSequenceDiagramValue[] $arrValues
Returns:
UmlSequenceDiagramMessage me

Definition at line 305 of file UmlSequenceDiagramMessage.class.php.

00306     {
00307         $this->arrValues = $arrValues;
00308         return $this;
00309     }

Member Data Documentation

$arrNotesAfter = array() [protected]

UmlSequenceDiagramNote Collection with the notes what should be after the message

UmlSequenceDiagramNote[]

Definition at line 102 of file UmlSequenceDiagramMessage.class.php.

$arrNotesBefore = array() [protected]

UmlSequenceDiagramNote Collection with the notes what should be before the message

UmlSequenceDiagramNote[]

Definition at line 93 of file UmlSequenceDiagramMessage.class.php.

$arrValues = Array() [protected]

Values of the message

UmlSequenceDiagramValue[]

Definition at line 55 of file UmlSequenceDiagramMessage.class.php.

$intPosition [protected]

Unique Position of each message of the sequence diagram

integer

Definition at line 77 of file UmlSequenceDiagramMessage.class.php.

Referenced by setPosition().

$intTimeEnd [protected]

Timestamp when the message was finished

integer

Definition at line 69 of file UmlSequenceDiagramMessage.class.php.

$intTimeStart [protected]

Timestamp when the message was received

integer

Definition at line 62 of file UmlSequenceDiagramMessage.class.php.

$objActorFrom = null [protected]

Actor what send the message

UmlSequenceDiagramActor

Definition at line 41 of file UmlSequenceDiagramMessage.class.php.

$objActorTo = null [protected]

Actor what received the message

UmlSequenceDiagramActor

Definition at line 48 of file UmlSequenceDiagramMessage.class.php.

$objUmlSequenceDiagram [protected]

Uml Sequence Diagram parent of this message

UmlSequenceDiagram

Definition at line 84 of file UmlSequenceDiagramMessage.class.php.

$strMethod = null [protected]

Method of the message

string

Definition at line 27 of file UmlSequenceDiagramMessage.class.php.

Referenced by setMethod().

$strText = null [protected]

Text of the message

string

Definition at line 20 of file UmlSequenceDiagramMessage.class.php.

Referenced by setText().

$strType = null [protected]

Type of the message ( call or return )

string

Definition at line 34 of file UmlSequenceDiagramMessage.class.php.

Referenced by setType().

The documentation for this class was generated from the following file:
Generated on Thu Feb 3 03:55:04 2011 for CodeToDiagram by  doxygen 1.5.9