Storage Class Reference

#include <Component.hpp>

Inheritance diagram for Storage:

Public Member Functions
	Storage ()
	Storage (Component *parent)
long long	GetSize ()
void	SetSize (long long _size)
Public Member Functions inherited from Component
	Component (int _id=0, string _name="unknown", int _componentType=SYS_SAGE_COMPONENT_NONE)
	Component (Component *parent, int _id=0, string _name="unknown", int _componentType=SYS_SAGE_COMPONENT_NONE)
void	InsertChild (Component *child)
int	InsertBetweenParentAndChild (Component *parent, Component *child, bool alreadyParentsChild)
int	InsertBetweenParentAndChildren (Component *parent, vector< Component * > children, bool alreadyParentsChild)
int	RemoveChild (Component *child)
void	SetParent (Component *parent)
void	PrintSubtree ()
void	PrintAllDataPathsInSubtree ()
string	GetName ()
void	SetName (string _name)
int	GetId ()
int	GetComponentType ()
string	GetComponentTypeStr ()
vector< Component * > *	GetChildren ()
Component *	GetParent ()
Component *	GetChild (int _id)
Component *	GetChildById (int _id)
Component *	GetChildByType (int _componentType)
vector< Component * >	GetAllChildrenByType (int _componentType)
void	GetAllChildrenByType (vector< Component * > *_outArray, int _componentType)
Component *	FindSubcomponentById (int _id, int _componentType)
Component *	GetSubcomponentById (int _id, int _componentType)
void	GetAllSubcomponentsByType (vector< Component * > *outArray, int _componentType)
vector< Component * >	GetAllSubcomponentsByType (int _componentType)
int	CountAllSubcomponents ()
int	CountAllSubcomponentsByType (int _componentType)
int	CountAllChildrenByType (int _componentType)
Component *	GetAncestorByType (int _componentType)
int	GetNumThreads ()
int	GetSubtreeDepth ()
Component *	GetNthAncestor (int n)
void	GetNthDescendents (vector< Component * > *outArray, int depth)
vector< Component * >	GetNthDescendents (int depth)
void	GetSubcomponentsByType (vector< Component * > *outArray, int componentType)
vector< Component * >	GetSubcomponentsByType (int _componentType)
void	GetComponentsInSubtree (vector< Component * > *outArray)
vector< Component * >	GetComponentsInSubtree ()
vector< DataPath * > *	GetDataPaths (int orientation)
DataPath *	GetDataPathByType (int dp_type, int orientation)
void	GetAllDataPathsByType (vector< DataPath * > *outDpArr, int dp_type, int orientation)
vector< DataPath * >	GetAllDataPathsByType (int dp_type, int orientation)
int	CheckComponentTreeConsistency ()
	Checks the consistency of the component tree starting from this component.
int	GetTopologySize (unsigned *out_component_size, unsigned *out_dataPathSize)
int	GetDepth (bool refresh)
void	DeleteDataPath (DataPath *dp)
void	DeleteAllDataPaths ()
void	DeleteSubtree ()
void	Delete (bool withSubtree=true)

Additional Inherited Members
Public Attributes inherited from Component
std::map< std::string, void * >	attrib
Protected Attributes inherited from Component
int	id
int	depth
string	name
int	count {-1}
const int	componentType
vector< Component * >	children
Component *	parent { nullptr }
vector< DataPath * >	dp_incoming
vector< DataPath * >	dp_outgoing

Detailed Description

Class Storage - represents a persistent storage device. (Of any kind.)
This class is a child of Component class, therefore inherits its attributes and methods.

Constructor & Destructor Documentation

Storage() [1/2]

Storage::Storage

(

)

Storage constructor (no automatic insertion in the Component Tree). Sets:

Parameters

_id	= 0
_name	= "Storage"
componentType=>SYS_SAGE_COMPONENT_STORAGE

Storage() [2/2]

Storage::Storage

(

Component *

parent

)

Storage constructor with insertion into the Component Tree as the parent 's child (as long as parent is an existing Component). Sets:

Parameters

parent	= the parent
_id	= 0
_name	= "Storage"
componentType=>SYS_SAGE_COMPONENT_STORAGE

Member Function Documentation

GetSize()

long long Storage::GetSize

(

)

Retrieves size/capacity of the storage device

Returns

size

See also

size

SetSize()

void Storage::SetSize

(

long long

_size

)

Sets size/capacity of the storage device

Parameters

_size

= size

---

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

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