UmlSequenceDiagramActor Class Reference

List of all members.

Public Member Functions

__construct ()

setUmlSequenceDiagram (UmlSequenceDiagram $objUmlSequenceDiagram)

getUmlSequenceDiagram ()

getId ()

setId ($strId)

getPosition ()

setPosition ($intPosition)

getType ()

setType ($strType)

setStereotype (UmlSequenceDiagramStereotype $objStereotype)

getStereotype ()

getName ()

setName ($strName)

getClassName ()

setClassName ($strClassName)

Protected Attributes

$objUmlSequenceDiagram

$strId

$intPosition

$objStereotype = null

$strName

$strClassName

Detailed Description

Actor of the object of the uml sequence diagram object

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

Definition at line 11 of file UmlSequenceDiagramActor.class.php.

Constructor & Destructor Documentation

__construct ( )

Set the default type of the actor

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

References setType().

00060     {
00061         $this->setType( "system" );
00062     }

Member Function Documentation

getClassName ( )

Get the class name of the actor

See also:: UmlSequenceDiagramActor::setClassName( string )
UmlSequenceDiagramActor->strClassName

Returns:: string

Definition at line 218 of file UmlSequenceDiagramActor.class.php.

00218                                    {
00219         return $this->strClassName;
00220     }

getId ( )

Get the id of the actor

See also:: UmlSequenceDiagramActor::setId( string )
UmlSequenceDiagramActor->strId

Returns:: string

Definition at line 99 of file UmlSequenceDiagramActor.class.php.

Referenced by UmlSequenceDiagram::addActor().

00100     {
00101         return $this->strId;
00102     }

getName ( )

Get the name of the actor

See also:: UmlSequenceDiagramActor::setName( string )
UmlSequenceDiagramActor->strName

Returns:: string

Definition at line 194 of file UmlSequenceDiagramActor.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getActor().

00195     {
00196         return $this->strName;
00197     }

getPosition ( )

Get the position of the actor

See also:: UmlSequenceDiagramActor::setPosition( integer )
UmlSequenceDiagramActor->intPosition

Returns:: integer

Definition at line 124 of file UmlSequenceDiagramActor.class.php.

00125     {
00126         return $this->intPosition;
00127     }

getStereotype ( )

Get the stereotype of the actor

Returns:: UmlSequenceDiagramStereotype

Definition at line 182 of file UmlSequenceDiagramActor.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getActor().

00183     {
00184         return $this->objType;
00185     }

getType ( )

Get the type of the actor

See also:: UmlSequenceDiagramActor::setType( string )
UmlSequenceDiagramActor->objStereotype

Returns:: string

Definition at line 149 of file UmlSequenceDiagramActor.class.php.

00150     {
00151         return $this->objType->getName();
00152     }

getUmlSequenceDiagram ( )

Returns the uml sequence diagram parent of the actor

See also:

UmlSequenceDiagramActor::setUmlSequenceDiagram( UmlSequenceDiagram )

UmlSequenceDiagramActor->objUmlSequenceDiagram

UmlSequenceDiagram

Returns:: UmlSequenceDiagram

Definition at line 87 of file UmlSequenceDiagramActor.class.php.

00088     {
00089         return $this->objUmlSequenceDiagram;
00090     }

setClassName ( $ strClassName )

Set the class name of the actor

See also:: UmlSequenceDiagramActor::getClassName()
UmlSequenceDiagramActor->strClassName

Returns:: UmlSequenceDiagramActor

Definition at line 229 of file UmlSequenceDiagramActor.class.php.

References $strClassName.

00229                                                 {
00230         $this->strClassName = $strClassName;
00231     }

setId ( $ strId )

Set the id of the actor

See also:: UmlSequenceDiagramActor::getId()
UmlSequenceDiagramActor->strId

Returns:: UmlSequenceDiagramActor

Definition at line 111 of file UmlSequenceDiagramActor.class.php.

References $strId.

00112     {
00113         $this->strId = $strId;
00114         return $this;
00115     }

setName ( $ strName )

Set the name of the actor

See also:: UmlSequenceDiagramActor::getName()
UmlSequenceDiagramActor->strName

Returns:: UmlSequenceDiagramActor

Definition at line 206 of file UmlSequenceDiagramActor.class.php.

References $strName.

00207     {
00208         $this->strName = $strName;
00209     }

setPosition ( $ intPosition )

Set the position of the actor

See also:: UmlSequenceDiagramActor::getPosition()
UmlSequenceDiagramActor->intPosition

Returns:: UmlSequenceDiagramActor

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

References $intPosition.

Referenced by UmlSequenceDiagram::addActor().

00137     {
00138         $this->intPosition = $intPosition;
00139         return $this;
00140     }

setStereotype ( UmlSequenceDiagramStereotype $ objStereotype )

Set the stereotype of the actor

Returns:: UmlSequenceDiagramStereotype

Definition at line 172 of file UmlSequenceDiagramActor.class.php.

00173     {
00174         return $this->objType = $objStereotype;
00175     }

setType ( $ strType )

Set the type of the actor

See also:: UmlSequenceDiagramActor::getType()
UmlSequenceDiagramActor->objType

Returns:: UmlSequenceDiagramActor

Exceptions:

UmlSequenceDiagramException

Definition at line 162 of file UmlSequenceDiagramActor.class.php.

References UmlSequenceDiagramStereotype::getStereotypeByName().

Referenced by __construct().

00163     {
00164         $this->objType = UmlSequenceDiagramStereotype::getStereotypeByName( $strType );
00165     }

setUmlSequenceDiagram ( UmlSequenceDiagram $ objUmlSequenceDiagram )

Inform the uml sequence diagram parent of the actor

UmlSequenceDiagramActor->objUmlSequenceDiagram

UmlSequenceDiagram

Parameters:

UmlSequenceDiagram

$objUmlSequenceDiagram

Returns:: UmlSequenceDiagramActor me

Definition at line 73 of file UmlSequenceDiagramActor.class.php.

Referenced by UmlSequenceDiagram::addActor().

00074     {
00075         $this->objUmlSequenceDiagram = $objUmlSequenceDiagram;
00076         return $this;
00077     }

Member Data Documentation

$intPosition [protected]

Unique Position of each actor of the sequence

integer

Definition at line 33 of file UmlSequenceDiagramActor.class.php.

Referenced by setPosition().

$objStereotype = null [protected]

Type of the actor

UmlSequenceDiagramStereotype

Definition at line 40 of file UmlSequenceDiagramActor.class.php.

$objUmlSequenceDiagram [protected]

Uml Sequence Diagram parent of this message

UmlSequenceDiagram

Definition at line 19 of file UmlSequenceDiagramActor.class.php.

$strClassName [protected]

Class of the object actor

string

Definition at line 54 of file UmlSequenceDiagramActor.class.php.

Referenced by setClassName().

$strId [protected]

Unique Id of each actor of the sequence

string

Definition at line 26 of file UmlSequenceDiagramActor.class.php.

Referenced by setId().

$strName [protected]

Name of the actor

string

Definition at line 47 of file UmlSequenceDiagramActor.class.php.

Referenced by setName().

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

components/umlSequenceDiagram/UmlSequenceDiagramActor.class.php


Public Member Functions
	__construct ()
	setUmlSequenceDiagram (UmlSequenceDiagram $objUmlSequenceDiagram)
	getUmlSequenceDiagram ()
	getId ()
	setId ($strId)
	getPosition ()
	setPosition ($intPosition)
	getType ()
	setType ($strType)
	setStereotype (UmlSequenceDiagramStereotype $objStereotype)
	getStereotype ()
	getName ()
	setName ($strName)
	getClassName ()
	setClassName ($strClassName)
Protected Attributes
	$objUmlSequenceDiagram
	$strId
	$intPosition
	$objStereotype = null
	$strName
	$strClassName