UmlSequenceDiagramStereotype Class Reference

List of all members.

Public Member Functions
	setDefault ($booDefault)
	getDefault ()
	setName ($strName)
	getName ()
	setImage ($strImage)
	getImage ()
Static Public Member Functions
static	addStereotype (UmlSequenceDiagramStereotype $objStereotype)
static	getStereotypeByName ($strName)
Protected Attributes
	$booDefault
	$strName
	$strImage
Static Protected Attributes
static	$arrInstances = array()

---

Detailed Description

UmlSequenceDiagramStereotype - Define the stereotypes of the uml sequence diagram UmlSequenceDiagramStereotype define the stereotype of the actors into the sequence diagram object

Author:

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

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

---

Member Function Documentation

static addStereotype

(

UmlSequenceDiagramStereotype $

objStereotype

)

[static]

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

References getName().

Referenced by CodeToDiagram::loadDefaultsStereotypes().

    {
        self::$arrInstances[ $objStereotype->getName()  ] = $objStereotype;
        return $objStereotype;
    }

getDefault

(

)

See also:

UmlSequenceDiagramStereotype->boolDefault

UmlSequenceDiagramStereotype::setDefault( boolean )

Returns:

boolean $booDefault

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

    {
        return $this->booDefault;
    }

getImage

(

)

Get the image file name

See also:

UmlSequenceDiagramStereotype->strImage

UmlSequenceDiagramStereotype->setImage( string )

Returns:

string $strImage

Definition at line 140 of file UmlSequenceDiagramStereotype.class.php.

    {
        return $this->strImage;
    }

getName

(

)

Get the name of the stereotype

See also:

UmlSequenceDiagramStereotype->strName

UmlSequenceDiagramStereotype::setName( string )

Returns:

string

Definition at line 114 of file UmlSequenceDiagramStereotype.class.php.

Referenced by addStereotype().

    {
        return $this->strName;
    }

static getStereotypeByName

(

$

strName

)

[static]

Get the stereotype instance by the name

Parameters:

string

$strName

Returns:

UmlSequenceDiagramStereotype

Definition at line 60 of file UmlSequenceDiagramStereotype.class.php.

References $strName.

Referenced by CodeInstrumentationReceiverConfiguration::__construct(), and UmlSequenceDiagramActor::setType().

    {
        if( !isset( self::$arrInstances[ $strName ] ) )
        {
            throw new UmlSequenceDiagramException( 'unknow uml sequence diagram stereotype ' . $strName );
        }
        return self::$arrInstances[ $strName  ];
    }

setDefault

(

$

booDefault

)

Set if the stereotype it is default

See also:

UmlSequenceDiagramStereotype->boolDefault

UmlSequenceDiagramStereotype::getDefault()

Parameters:

boolean

$booDefault

Returns:

UmlSequenceDiagramStereotype

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

References $booDefault.

    {
        $this->booDefault = $booDefault;
        return $this;
    }

setImage

(

$

strImage

)

Set the image file name

See also:

UmlSequenceDiagramStereotype->strImage

UmlSequenceDiagramStereotype->getImage()

Parameters:

string

$strImage

Returns:

UmlSequenceDiagramStereotype

Definition at line 127 of file UmlSequenceDiagramStereotype.class.php.

References $strImage.

    {
        $this->strImage = $strImage;
        return $this;
    }

setName

(

$

strName

)

See also:

UmlSequenceDiagramStereotype->strName

UmlSequenceDiagramStereotype::getName()

Parameters:

string

$strName

Returns:

UmlSequenceDiagramStereotype

Definition at line 101 of file UmlSequenceDiagramStereotype.class.php.

References $strName.

    {
        $this->strName = $strName;
        return $this;
    }

---

Member Data Documentation

$arrInstances = array() [static, protected]

Array of the instances of the UmlSequenceDiagramStereotype by the name

UmlSequenceDiagramStereotype[]

Definition at line 46 of file UmlSequenceDiagramStereotype.class.php.

$booDefault [protected]

Flag to control if the element it is a default stereotype true in this case or a personalized one false in this last case.

boolean

Definition at line 23 of file UmlSequenceDiagramStereotype.class.php.

Referenced by setDefault().

$strImage [protected]

filename of the image of the stereotype.

string

Definition at line 38 of file UmlSequenceDiagramStereotype.class.php.

Referenced by setImage().

$strName [protected]

name of the stereotype

string

Definition at line 30 of file UmlSequenceDiagramStereotype.class.php.

Referenced by getStereotypeByName(), and setName().

---

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

• components/umlSequenceDiagram/UmlSequenceDiagramStereotype.class.php