GraphTool  1.0
Tool for analyzing and graphically visualizing code dependencies for Ericsson.
 All Classes Namespaces Functions Variables Typedefs Enumerations Pages
Public Member Functions | Protected Member Functions | List of all members
Module Class Reference

Public Member Functions

 Module (std::string name)
 Constructor.
 
 ~Module ()
 Destructor.
 
void remove_from_datastructure ()
 
std::string name () const
 
SWUswu ()
 
ModDependencySet * dependencies ()
 
ModDependentSet * dependents ()
 
std::set< std::string > * files ()
 
bool add_dependency (Dependency< Module, Module > *mod_dep)
 
bool remove_dependency (Module *m)
 
void add_external_dependent ()
 Adds an external dependency to this module. Is currently only a counter of how many external dependents this module have.
 
bool remove_external_dependent ()
 Removes one external dependent from this module.
 
bool has_external_dependents ()
 returns whether the number of external dependents is > 0 or not.
 
void add_file (std::string file)
 
void remove_file (std::string file)
 
void set_swu (SWU *s)
 
void set_type (GraphTool::MemType type)
 Set the memory type of this module.
 
GraphTool::MemType type ()
 Getter for memory type of this module.
 

Protected Member Functions

bool add_dependent (Dependency< Module, Module > *)
 
bool remove_dependent (Module *)
 

Member Function Documentation

bool Module::add_dependency ( Dependency< Module, Module > *  mod_dep)

Inserts the given dependency into the set of dependencies and then inserts the dependency as dependent for the destination module

Parameters
Dependency>Module,Module>*mod_dep pointer to dependency to be inserted
Returns
bool whether the insert succeeded or failed
bool Module::add_dependent ( Dependency< Module, Module > *  mod_dep)
protected

Adds a_module to dependents

void Module::add_file ( std::string  file)

Adds a file to the set of files.

ModDependencySet * Module::dependencies ( )

Accessor for the dependencies of this module

Returns
ModDependencySet* pointer to set of dependencies
ModDependentSet * Module::dependents ( )

Accessor for the dependents of this module

Returns
ModDependencySet* pointer to set of dependents
std::string Module::name ( ) const

Accessor for the module name

Returns
string name of the module
bool Module::remove_dependency ( Module m)

Removes the dependency that originates from the current module to the given module. Also removes the dependent for the given module.

Parameters
Module*m pointer to the dependent module.
Returns
bool whether it succeeded removing the dependency or not
bool Module::remove_dependent ( Module a_module)
protected

Removes a_module from dependents

void Module::remove_file ( std::string  file)

Removes the specified file from this module.

void Module::remove_from_datastructure ( )

Remove this module cleanly from the datastructure. Required if deleting / removing this module manually, must be called prior to delete.

void Module::set_swu ( SWU s)

Associates the given SWU with the current module.

Parameters
SWU*s pointer to a SWU that is to be associated with this module
SWU * Module::swu ( )

Accessor for the associated SWU

Returns
SWU* pointer to the associated SWU

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