GraphTool  1.0
Tool for analyzing and graphically visualizing code dependencies for Ericsson.
 All Classes Namespaces Functions Variables Typedefs Enumerations Pages
Public Member Functions | List of all members
Dependency< T1, T2 > Class Template Reference

Forward declarations for functors. More...

#include <defines.h>

Public Member Functions

 Dependency (T1 *from, T2 *to, bool is_absolute=false)
 
void remove_from_datastructure ()
 
T1 * from ()
 
T2 * to ()
 
const T1 * from_const () const
 
const T2 * to_const () const
 
bool absolute () const
 
bool relative () const
 
void set_absolute ()
 
void set_relative ()
 
GraphTool::MemType type () const
 
GraphTool::MemType type ()
 
std::string type_string ()
 
void set_type (GraphTool::MemType type) const
 

Detailed Description

template<class T1, class T2>
class Dependency< T1, T2 >

Forward declarations for functors.

Forward declarations.

The dependency class represents a dependency between two class objects. One dependency could be for example between two SWUs.

Constructor & Destructor Documentation

template<class T1, class T2>
Dependency< T1, T2 >::Dependency ( T1 *  from,
T2 *  to,
bool  is_absolute = false 
)
inline

Provide dependency source, destination and whether the dependency is absolute or not

Member Function Documentation

template<class T1, class T2>
bool Dependency< T1, T2 >::absolute ( ) const
inline

Return true if the dependency is absolute, returns false if not. A dependency can either be absolute or relative.

Returns
True if dependency is absolute, false if not.
template<class T1, class T2>
T1* Dependency< T1, T2 >::from ( )
inline

Returns a pointer to the class object the dependency points from.

Returns
The object the dependency originates from.
template<class T1, class T2>
const T1* Dependency< T1, T2 >::from_const ( ) const
inline

Return a constant pointer to the class object the dependency points from.

Returns
The object the dependency originates from..
template<class T1, class T2>
bool Dependency< T1, T2 >::relative ( ) const
inline

Return true if the dependency is relative, returns false if not. A dependency can either be absolute or relative.

Returns
True if dependency is relative, false if not.
template<class T1, class T2>
void Dependency< T1, T2 >::remove_from_datastructure ( )
inline

Utility method to remove this one cleanly from the dataset.

template<class T1, class T2>
void Dependency< T1, T2 >::set_absolute ( )
inline

Set the dependency to be absolute. A dependency can either be absolute or relative.

template<class T1, class T2>
void Dependency< T1, T2 >::set_relative ( )
inline

Set the dependency to be relative, absolute false. A dependency can either be absolute or relative.

template<class T1, class T2>
void Dependency< T1, T2 >::set_type ( GraphTool::MemType  type) const
inline

Set the memtype of the dependency. The different memtypes are: UNDEFINED, LDM, LPM, LDM_LPM // 2014-05-02

Parameters
Thememtype that the dependency should have.
template<class T1, class T2>
T2* Dependency< T1, T2 >::to ( )
inline

Return a pointer to the class object the dependency points to.

Returns
The object the dependency points towards.
template<class T1, class T2>
const T2* Dependency< T1, T2 >::to_const ( ) const
inline

Return a constant pointer to the class object the dependency points to.

Returns
The object the dependency points towards.
template<class T1, class T2>
GraphTool::MemType Dependency< T1, T2 >::type ( ) const
inline

Return the memtype, as constant, of the dependency. The different memtypes are: UNDEFINED, LDM, LPM, LDM_LPM // 2014-05-02

Returns
The memtype of the dependency.
template<class T1, class T2>
GraphTool::MemType Dependency< T1, T2 >::type ( )
inline

Return the memtype, of the dependency. The different memtypes are: UNDEFINED, LDM, LPM, LDM_LPM // 2014-05-02

Returns
The memtype of the dependency.
template<class T1, class T2>
std::string Dependency< T1, T2 >::type_string ( )
inline

Return the memtype, of the dependency as a string. The different memtypes are: UNDEFINED, LDM, LPM, LDM_LPM // 2014-05-02

Returns
The memtype of the dependency.

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