DataPath Class Reference

#include <DataPath.hpp>

Public Member Functions
	DataPath (Component *_source, Component *_target, int _oriented, int _type=SYS_SAGE_DATAPATH_TYPE_NONE)
	DataPath (Component *_source, Component *_target, int _oriented, double _bw, double _latency)
	DataPath (Component *_source, Component *_target, int _oriented, int _type, double _bw, double _latency)
Component *	GetSource ()
Component *	GetTarget ()
double	GetBandwidth ()
void	SetBandwidth (double _bandwidth)
double	GetLatency ()
void	SetLatency (double _latency)
void	UpdateSource (Component *_new_source)
void	UpdateTarget (Component *_new_target)
int	GetDataPathType ()
int	GetOrientation ()
void	Print ()
void	DeleteDataPath ()

Public Attributes
std::map< std::string, void * >	attrib

Detailed Description

Class DataPath represents Data Paths in the topology – Data Paths represent an arbitrary relation (or data movement) between two Components from the Component Tree.
Data Paths create a Data-Path graph, which is a structure orthogonal to the Component Tree.
Each Component contains a reference to all Data Paths going to or from this components (as well as parents and children in the Component Tree). Using these references, it is possible to navigate between the Components and to view the data stores in the Components or the Data Paths.

Constructor & Destructor Documentation

DataPath() [1/3]

DataPath::DataPath	(	Component *	_source,
		Component *	_target,
		int	_oriented,
		int	_type = SYS_SAGE_DATAPATH_TYPE_NONE )

DataPath constructor.

Parameters

_source	- pointer to the source Component. (If _oriented == SYS_SAGE_DATAPATH_BIDIRECTIONAL, there is no difference between _source and _target)
_target	- pointer to the target Component.
_oriented	- is the Data Path oriented? (SYS_SAGE_DATAPATH_ORIENTED = oriented DP; SYS_SAGE_DATAPATH_BIDIRECTIONAL = NOT oriented DP)
_type	- (optional parameter) Denotes type of the Data Path – helps to distinguish Data Paths carrying different type of information. The value is user-defined. If not specified, the Data Path will have type SYS_SAGE_DATAPATH_TYPE_NONE. Predefined types: SYS_SAGE_DATAPATH_TYPE_NONE, SYS_SAGE_DATAPATH_TYPE_LOGICAL, SYS_SAGE_DATAPATH_TYPE_PHYSICAL, SYS_SAGE_DATAPATH_TYPE_L3CAT. Each user can define an arbitrary type as an integer value > 1024

DataPath() [2/3]

DataPath::DataPath	(	Component *	_source,
		Component *	_target,
		int	_oriented,
		double	_bw,
		double	_latency )

DataPath constructor. DataPath type is set to SYS_SAGE_DATAPATH_TYPE_NONE.

Parameters

_source	- pointer to the source Component. (If _oriented == SYS_SAGE_DATAPATH_BIDIRECTIONAL, there is no difference between _source and _target)
_target	- pointer to the target Component.
_oriented	- is the Data Path oriented? (SYS_SAGE_DATAPATH_ORIENTED = oriented DP; SYS_SAGE_DATAPATH_BIDIRECTIONAL = NOT oriented DP)
_bw	- bandwidth from the source(provides the data) to the target(requests the data)
_latency	- Data load latency from the source(provides the data) to the target(requests the data)

DataPath() [3/3]

DataPath::DataPath	(	Component *	_source,
		Component *	_target,
		int	_oriented,
		int	_type,
		double	_bw,
		double	_latency )

DataPath constructor.

Parameters

_source	- pointer to the source Component. (If _oriented == SYS_SAGE_DATAPATH_BIDIRECTIONAL, there is no difference between _source and _target)
_target	- pointer to the target Component.
_oriented	- is the Data Path oriented? (SYS_SAGE_DATAPATH_ORIENTED = oriented DP; SYS_SAGE_DATAPATH_BIDIRECTIONAL = NOT oriented DP)
_type	- (optional parameter) Denotes type of the Data Path – helps to distinguish Data Paths carrying different type of information. The value is user-defined. If not specified, the Data Path will have type SYS_SAGE_DATAPATH_TYPE_NONE. Predefined types: SYS_SAGE_DATAPATH_TYPE_NONE, SYS_SAGE_DATAPATH_TYPE_LOGICAL, SYS_SAGE_DATAPATH_TYPE_PHYSICAL, SYS_SAGE_DATAPATH_TYPE_L3CAT. Each user can define an arbitrary type as an integer value > 1024
_bw	- Bandwidth from the source(provides the data) to the target(requests the data)
_latency	- Data load latency from the source(provides the data) to the target(requests the data)

Member Function Documentation

DeleteDataPath()

void DataPath::DeleteDataPath

(

)

Deletes and de-allocates the DataPath pointer from the list(std::vector) of outgoing and incoming DataPaths of source and target Components.

See also

dp_incoming

dp_outgoing

GetBandwidth()

double DataPath::GetBandwidth

(

)

Returns

Bandwidth from the source(provides the data) to the target(requests the data)

GetDataPathType()

int DataPath::GetDataPathType

(

)

Returns

Type of the Data Path.

See also

dp_type

GetLatency()

double DataPath::GetLatency

(

)

Returns

Data load latency from the source(provides the data) to the target(requests the data)

GetOrientation()

int DataPath::GetOrientation

(

)

Retrieves the orientation of the datapath (SYS_SAGE_DATAPATH_ORIENTED or SYS_SAGE_DATAPATH_BIDIRECTIONAL)

Returns

orientation

See also

oriented

GetSource()

Component * DataPath::GetSource

(

)

Returns

Pointer to the source Component

GetTarget()

Component * DataPath::GetTarget

(

)

Returns

Pointer to the target Component

Print()

void DataPath::Print

(

)

Prints basic information about the Data Path to stdout. Prints componentType and Id of the source and target Components, the bandwidth, load latency, and the attributes; for each attribute, the name and value are printed, however the value is only retyped to uint64_t (therefore will print nonsensical values for other data types).

SetBandwidth()

void DataPath::SetBandwidth

(

double

_bandwidth

)

Sets the bandwidth from the source to the target.

Parameters

_bandwidth

- value for bw

See also

bw

SetLatency()

void DataPath::SetLatency

(

double

_latency

)

Sets the data load latency from the source to the target.

Parameters

_latency

- value for latency

See also

latency

UpdateSource()

void DataPath::UpdateSource

(

Component *

_new_source

)

Updates the source of the DataPath. The datapath is removed from the outgoing/incoming vectors of the old source and added to the vectors of the newer source.

Parameters

_new_source

- New source of the DataPath.

UpdateTarget()

void DataPath::UpdateTarget

(

Component *

_new_target

)

Updates the target of the DataPath. The datapath is removed from the outgoing/incoming vectors of the old target and added to the vectors of the newer target.

Parameters

_new_source

- New target of the DataPath.

Member Data Documentation

attrib

std::map<std::string, void*> DataPath::attrib

A map for storing arbitrary pieces of information or data.

• The key denotes the name of the attribute.
• The value points to the data, stored as a void*.

This data structure is designed to store a wide variety of data types by utilizing pointers to void. Due to its flexibility, it is essential to manage the types and memory allocation/deallocation carefully to avoid issues such as memory leaks or undefined behavior.

Usage:

1. Adding a new key-value pair:

std::string key = "exampleKey";
int* value = new int(42); // Dynamically allocate memory for the value
attrib[key] = static_cast<void*>(value); // Store the value in the map

1. Retrieving data from an existing key:

std::string key = "exampleKey";
if (attrib.find(key) != attrib.end()) {
    int* retrievedValue = static_cast<int*>(attrib[key]);
    std::cout << "Value: " << *retrievedValue << std::endl;
} else {
    std::cout << "Key not found." << std::endl;
}

1. Checking for the existence of a key:

std::string key = "exampleKey";
if (attrib.find(key) != attrib.end()) {
    std::cout << "Key exists." << std::endl;
} else {
    std::cout << "Key does not exist." << std::endl;
}

1. Removing a key-value pair and freeing memory:

std::string key = "exampleKey";
if (attrib.find(key) != attrib.end()) {
    int* value = static_cast<int*>(attrib[key]);
    delete value; // Free the dynamically allocated memory
    attrib.erase(key); // Remove the key-value pair from the map
}

1. Updating the value for an existing key:

std::string key = "exampleKey";
if (attrib.find(key) != attrib.end()) {
    int* oldValue = static_cast<int*>(attrib[key]);
    delete oldValue; // Free the old value
    int* newValue = new int(100); // Allocate new value
    attrib[key] = static_cast<void*>(newValue); // Update the map
}

Note:

• Proper memory management is crucial when using void* pointers. Always ensure that dynamically allocated memory is freed when no longer needed.
• Type safety is not enforced, so it is important to cast pointers to the correct type when retrieving values from the map.

---

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

• /Users/stepan/phd/repos/caps_sys-sage/src/DataPath.hpp
• /Users/stepan/phd/repos/caps_sys-sage/src/DataPath.cpp