UmlSequenceDiagram Class Reference

List of all members.

Public Member Functions

restart ()

setMessages (array $arrMessages)

getMessages ()

addMessage (UmlSequenceDiagramMessage $objMessage)

setActors (array $arrActors)

getActors ()

addActor (UmlSequenceDiagramActor $objActor)

setOutput ($strOutput)

getOutput ()

Protected Attributes

$arrActors = Array()

$arrMessages = Array()

$strOutput = ""

Detailed Description

Class what represent the UML sequence diagram using the object oriented strutcture to do that

Author:: Thiago Henrique Ramos da Mata <thiago.henrique.mata@gmail.com>

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

Member Function Documentation

addActor ( UmlSequenceDiagramActor $ objActor )

Add a actor into the Uml Sequence Diagram Object

See also:: UmlSequenceDiagram::setActors( UmlSequenceDiagramActor[] )
UmlSequenceDiagram::getActors()

Parameters:

UmlSequenceDiagramActor

$objActor

Returns:: UmlSequenceDiagram me

Definition at line 136 of file UmlSequenceDiagram.class.php.

References UmlSequenceDiagramActor::getId(), UmlSequenceDiagramActor::setPosition(), and UmlSequenceDiagramActor::setUmlSequenceDiagram().

Referenced by setActors().

00137     {
00138         $this->arrActors[ $objActor->getId() ] = $objActor;
00139         $objActor->setPosition( sizeof( $this->arrActors ) );
00140         $objActor->setUmlSequenceDiagram( $this );
00141         return $this;
00142     }

addMessage ( UmlSequenceDiagramMessage $ objMessage )

Add a message into the Uml Sequence Diagram Object

See also:: UmlSequenceDiagram::setMessages( UmlSequenceDiagramMessage[] )
UmlSequenceDiagram::getMessages()

Parameters:

UmlSequenceDiagramMessage

$objMessage

Returns:: UmlSequenceDiagram me

Definition at line 89 of file UmlSequenceDiagram.class.php.

References UmlSequenceDiagramMessage::setPosition(), and UmlSequenceDiagramMessage::setUmlSequenceDiagram().

Referenced by setMessages().

00090     {
00091         $this->arrMessages[] = $objMessage;
00092         $objMessage->setPosition( sizeof( $this->arrMessages ) );
00093         $objMessage->setUmlSequenceDiagram( $this );
00094         return $this;
00095     }

getActors ( )

Get the array of Uml Sequence Diagram Object

UmlSequenceDiagram->arrActors

UmlSequenceDiagram::addActor( UmlSequenceDiagramActor )

Returns:: UmlSequenceDiagramActor[]

Definition at line 123 of file UmlSequenceDiagram.class.php.

00124     {
00125         return $this->arrActors;
00126     }

getMessages ( )

Get the array of Uml Sequence Diagram Messages

UmlSequenceDiagram->arrMessages

UmlSequenceDiagram::addMessage( UmlSequenceDiagramMessage )

Returns:: UmlSequenceDiagramMessage[]

Definition at line 76 of file UmlSequenceDiagram.class.php.

00077     {
00078         return $this->arrMessages;
00079     }

getOutput ( )

get the output of the execution

See also:: UmlSequenceDiagram->strOutput
UmlSequenceDiagram::setOutput( string )

Returns:: string

Definition at line 165 of file UmlSequenceDiagram.class.php.

00166     {
00167         return $this->strOutput;
00168     }

restart ( )

Restart Uml Sequence Object. Clean all the old actors and messages

Returns:: UmlSequenceDiagram me

Definition at line 42 of file UmlSequenceDiagram.class.php.

00043     {
00044         $this->strOutput = "";
00045         $this->arrActors = array();
00046         $this->arrMessages = array();
00047         return $this;
00048     }

setActors ( array $ arrActors )

Set the array of Uml Sequence Diagram Object

See also:

UmlSequenceDiagram::getActors()

UmlSequenceDiagram->arrActors

UmlSequenceDiagram::addActor( UmlSequenceDiagramMessage )

Parameters:

array

$arrActors

Returns:: UmlSequenceDiagram me

Definition at line 106 of file UmlSequenceDiagram.class.php.

References addActor().

00107     {
00108         foreach( $arrActors as $objActor )
00109         {
00110             $this->addActor( $objActor );
00111         }
00112         return $this;
00113     }

setMessages ( array $ arrMessages )

Set the array of Uml Sequence Diagram Messages

See also:

UmlSequenceDiagram::getMessages()

UmlSequenceDiagram->arrMessages

UmlSequenceDiagram::addMessage( UmlSequenceDiagramMessage )

Parameters:

array

$arrMessages

Returns:: UmlSequenceDiagram me

Definition at line 59 of file UmlSequenceDiagram.class.php.

References addMessage().

00060     {
00061         foreach( $arrMessages as $objMessage )
00062         {
00063             $this->addMessage( $objMessage );
00064         }
00065         return $this;
00066     }

setOutput ( $ strOutput )

set the output of the execution

See also:: UmlSequenceDiagram->strOutput
UmlSequenceDiagram::getOutput()

Parameters:

string

$strOutput

Returns:: UmlSequenceDiagram

Definition at line 152 of file UmlSequenceDiagram.class.php.

References $strOutput.

00153     {
00154         $this->strOutput = $strOutput;
00155         return $this;
00156     }

Member Data Documentation

$arrActors = Array() [protected]

Array of Uml Sequence Diagram Actors of the Uml Sequence Diagram object

UmlSequenceDiagramActor[]

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

$arrMessages = Array() [protected]

Array of Uml Sequence Diagram Messages of the Uml Sequence Diagram object

UmlSequenceDiagramMessage[]

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

$strOutput = "" [protected]

Execution output

string

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

Referenced by setOutput().

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

components/umlSequenceDiagram/UmlSequenceDiagram.class.php


Public Member Functions
	restart ()
	setMessages (array $arrMessages)
	getMessages ()
	addMessage (UmlSequenceDiagramMessage $objMessage)
	setActors (array $arrActors)
	getActors ()
	addActor (UmlSequenceDiagramActor $objActor)
	setOutput ($strOutput)
	getOutput ()
Protected Attributes
	$arrActors = Array()
	$arrMessages = Array()
	$strOutput = ""