CodeInstrumentationReceiverConfiguration Class Reference

List of all members.

Public Member Functions

 setActive ($booActive)
 getActive ()
 setIgnoreNullReturns ($booIgnoreNullReturns)
 getIgnoreNullReturns ()
 setIgnoreRecursiveCalls ($booIgnoreRecursiveCalls)
 getIgnoreRecursiveCalls ()
 setMergeSameClassObjects ($booMergeSameClassObjects)
 getMergeSameClassObjects ()
 setGatekeeperClasses (MatchGatekeeper $objGatekeeperClasses)
 getGatekeeperClasses ()
 setGatekeeperMethods (MatchGatekeeper $objGatekeeperMethods)
 getGatekeeperMethods ()
 setMatchGroupStereotypes (MatchGroup $objMatchGroupStereotypes)
 getMatchGroupStereotypes ()
 __construct ()

Protected Attributes

 $booActive = true
 $booIgnoreNullReturns = true
 $booIgnoreRecursiveCalls = false
 $booMergeSameClassObjects = false
 $objGatekeeperClasses
 $objGatekeeperMethods
 $objMatchGroupStereotypes

Detailed Description

Class to set the configurations of the code instrumentation receiver

Since:
2009-07-01
Author:
Thiago Henrique Ramos da Mata <thiago.henrique.mata@gmail.com>

Definition at line 14 of file CodeInstrumentationReceiverConfiguration.class.php.

Constructor & Destructor Documentation

__construct (  ) 

Constructor of the Configuration. Create the internal objects.

Definition at line 257 of file CodeInstrumentationReceiverConfiguration.class.php.

References $objGatekeeperClasses, $objGatekeeperMethods, $objMatchGroupStereotypes, UmlSequenceDiagramStereotype::getStereotypeByName(), setGatekeeperClasses(), setGatekeeperMethods(), and setMatchGroupStereotypes().

00258     {
00259         // create the internal objects //
00260         $objGatekeeperClasses = new MatchGatekeeper();
00261         $this->setGatekeeperClasses( $objGatekeeperClasses );
00262 
00263         $objGatekeeperMethods = new MatchGatekeeper();
00264         $this->setGatekeeperMethods( $objGatekeeperMethods );
00265 
00266         $objMatchGroupStereotypes = new MatchGroup();
00267         $objDefaultStereotype = UmlSequenceDiagramStereotype::getStereotypeByName( "system" );
00268         $objMatchGroupStereotypes->setNotFoundValue( $objDefaultStereotype );
00269         $this->setMatchGroupStereotypes( $objMatchGroupStereotypes );
00270     }

Member Function Documentation

getActive (  ) 

Get if the code instrumentation is active

See also:
CodeInstrumentationReceiverConfiguration->booActive

CodeInstrumentationReceiverConfiguration::setActive( boolean )

Returns:
boolean true if is active

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

00102     {
00103         return $this->booActive;
00104     }

getGatekeeperClasses (  ) 

Get the gate keeper to the classes into the diagram

Returns:
MatchGatekeeper

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

00207     {
00208         return $this->objGatekeeperClasses;
00209     }

getGatekeeperMethods (  ) 

Get the gate keeper to the classes into the method

Returns:
MatchGatekeeper $objGatekeeperMethods

Definition at line 226 of file CodeInstrumentationReceiverConfiguration.class.php.

00227     {
00228         return $this->objGatekeeperMethods;
00229     }

getIgnoreNullReturns (  ) 

get the configuration paramenter if the code instrumentation should ignore the returns messages with null value returned.

See also:
CodeInstrumentationReceiverConfiguration->boolIgnoreNullReturns

CodeInstrumentationReceiverConfiguration::seIgnoreNullReturns( boolean )

Returns:
boolean true if should ignore the null returns

Definition at line 129 of file CodeInstrumentationReceiverConfiguration.class.php.

00130     {
00131         return $this->booIgnoreNullReturns;
00132     }

getIgnoreRecursiveCalls (  ) 

get the configuration paramenter if the code instrumentation should ignore the recursive messages.

See also:
CodeInstrumentationReceiverConfiguration->booIgnoreRecursiveCalls

CodeInstrumentationReceiverConfiguration::setIgnoreRecursiveCalls( boolean )

Returns:
boolean true if should ignore the recursive calls

Definition at line 157 of file CodeInstrumentationReceiverConfiguration.class.php.

00158     {
00159         return $this->booIgnoreRecursiveCalls;
00160     }

getMatchGroupStereotypes (  ) 

Get the match group to the stereotype definition

Returns:
MatchGroup

Definition at line 247 of file CodeInstrumentationReceiverConfiguration.class.php.

00248     {
00249         return $this->objMatchGroupStereotypes;
00250     }

getMergeSameClassObjects (  ) 

get the configuration paramenter if the code instrumentation should merge same class objects as one actor.

See also:
CodeInstrumentationReceiverConfiguration->booMergeSameClassObjects

CodeInstrumentationReceiverConfiguration::setMergeSameClassObjects( boolean )

Returns:
boolean true if should merge same class object

Definition at line 186 of file CodeInstrumentationReceiverConfiguration.class.php.

00187     {
00188         return $this->booMergeSameClassObjects;
00189     }

setActive ( $  booActive  ) 

Set if the code instrumentation is active.

See also:
CodeInstrumentationReceiverConfiguration->booActive

CodeInstrumentationReceiverConfiguration::getActive()

Parameters:
boolean $booActive true to be active
Returns:
CodeInstrumentationReceiverConfiguration me

Definition at line 88 of file CodeInstrumentationReceiverConfiguration.class.php.

References $booActive.

00089     {
00090         $this->booActive = $booActive;
00091         return $this;
00092     }

setGatekeeperClasses ( MatchGatekeeper $  objGatekeeperClasses  ) 

Set the gate keeper to the classes into the diagram

Parameters:
MatchGatekeeper $objGatekeeperClasses

Definition at line 196 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by __construct().

00197     {
00198         $this->objGatekeeperClasses = $objGatekeeperClasses;
00199     }

setGatekeeperMethods ( MatchGatekeeper $  objGatekeeperMethods  ) 

Set the gate keeper to the classes into the method

Parameters:
MatchGatekeeper $objGatekeeperMethods

Definition at line 216 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by __construct().

00217     {
00218         $this->objGatekeeperMethods = $objGatekeeperMethods;
00219     }

setIgnoreNullReturns ( $  booIgnoreNullReturns  ) 

Set the configuration paramenter if the code instrumentation should ignore the returns messages with null value returned.

See also:
CodeInstrumentationReceiverConfiguration->boolIgnoreNullReturns

CodeInstrumentationReceiverConfiguration::geIgnoreNullReturns()

Parameters:
boolean $booIgnoreNullReturns true if should ignore the null returns
Returns:
CodeInstrumentationReceiverConfiguration me

Definition at line 115 of file CodeInstrumentationReceiverConfiguration.class.php.

References $booIgnoreNullReturns.

00116     {
00117         $this->booIgnoreNullReturns = $booIgnoreNullReturns;
00118         return $this;
00119     }

setIgnoreRecursiveCalls ( $  booIgnoreRecursiveCalls  ) 

Set the configuration paramenter if the code instrumentation should ignore the recursive messages.

See also:
CodeInstrumentationReceiverConfiguration->booIgnoreRecursiveCalls

CodeInstrumentationReceiverConfiguration::getIgnoreRecursiveCalls()

Parameters:
boolean $booIgnoreNullReturns true if should ignore the recursive calls
Returns:
CodeInstrumentationReceiverConfiguration me

Definition at line 143 of file CodeInstrumentationReceiverConfiguration.class.php.

References $booIgnoreRecursiveCalls.

00144     {
00145         $this->booIgnoreRecursiveCalls = $booIgnoreRecursiveCalls;
00146         return $this;
00147     }

setMatchGroupStereotypes ( MatchGroup $  objMatchGroupStereotypes  ) 

Set the match group to the stereotype definition

Parameters:
MatchGroup $objMatchGroupStereotypes

Definition at line 236 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by __construct().

00237     {
00238         $this->objMatchGroupStereotypes = $objMatchGroupStereotypes;
00239         return $this;
00240     }

setMergeSameClassObjects ( $  booMergeSameClassObjects  ) 

Set the configuration paramenter if the code instrumentation should merge same class objects as one actor.

See also:
CodeInstrumentationReceiverConfiguration->booMergeSameClassObjects

CodeInstrumentationReceiverConfiguration::getMergeSameClassObjects()

Parameters:
boolean $booMergeSameClassObjects true if should should merge same class object
Returns:
CodeInstrumentationReceiverConfiguration me

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

References $booMergeSameClassObjects.

00173     {
00174         $this->booMergeSameClassObjects = $booMergeSameClassObjects;
00175         return $this;
00176     }

Member Data Documentation

$booActive = true [protected]

param to control if the code instrumentation is active. Can be changed in execution time to ignore some slice of the execution.

Example: 
  // logged code //
  $this->setActive( false );
  // not logged code //
  $this->setActive( true );
  // logged code //
returns 
 true
boolean

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

Referenced by setActive().

$booIgnoreNullReturns = true [protected]

param if the null return should be saved as a message into the uml sequence diagram object

boolean

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

Referenced by setIgnoreNullReturns().

$booIgnoreRecursiveCalls = false [protected]

param if the recursive call should be ignored into the uml sequence diagram object

boolean

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

Referenced by setIgnoreRecursiveCalls().

$booMergeSameClassObjects = false [protected]

param of control if the messages between objects of the same class should be saved into the uml sequence diagram object as recursive calls into the same object

boolean

Definition at line 56 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by setMergeSameClassObjects().

$objGatekeeperClasses [protected]

Gate keeper of the classes into the diagram

MatchGatekeeper

Definition at line 64 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by __construct().

$objGatekeeperMethods [protected]

Gate keeper of the methods into the diagram

MatchGatekeeper

Definition at line 71 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by __construct().

$objMatchGroupStereotypes [protected]

Match Group to define the stereotypes of the classes

MatchGroup

Definition at line 78 of file CodeInstrumentationReceiverConfiguration.class.php.

Referenced by __construct().

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