cca::ComponentInfo Class Reference

#include <Info.h>

Inheritance diagram for cca::ComponentInfo:

Collaboration diagram for cca::ComponentInfo:

List of all members.

Public Types
typedef std::pair< std::string, InputPortPtr >	NamedInputPort
typedef std::pair< std::string, OutputPortPtr >	NamedOutputPort
typedef std::map< std::string, InputPortPtr >	NamedInputPorts
typedef std::map< std::string, OutputPortPtr >	NamedOutputPorts
Public Member Functions
	ComponentInfo (const std::string &name)
	Constructor.
virtual	~ComponentInfo ()
virtual std::string	print () const
	Prints the ComponentInfo.
void	displayStrategy (StrategyPtr strategy)
void	displayDataPorts (NamedInputPorts inputPorts, NamedOutputPorts outputPorts)
void	displayStatePorts (InputPort< ComponentState >::Ptr inputPort, OutputPort< ComponentState >::Ptr outputPort)
void	displayBeatPort (InputPort< cca::timing::Tick >::Ptr inputPort)
void	displayComponentState (ComponentStatePtr state)
void	displayProperties (const rsc::runtime::Properties &d, const rsc::runtime::Properties &p)
Public Attributes
std::string	name
std::string	stateCache
std::string	strategyCache
std::string	dataPortsCache
std::string	statePortsCache
std::string	beatPortsCache
std::string	propertiesCache
Protected Member Functions
virtual std::string	line (std::string str, unsigned int place=0, bool horizontal=false) const

---

Detailed Description

Definition at line 59 of file Info.h.

---

Member Typedef Documentation

typedef std::pair<std::string, InputPortPtr> cca::ComponentInfo::NamedInputPort

Definition at line 63 of file Info.h.

typedef std::map<std::string, InputPortPtr> cca::ComponentInfo::NamedInputPorts

Definition at line 65 of file Info.h.

typedef std::pair<std::string, OutputPortPtr> cca::ComponentInfo::NamedOutputPort

Definition at line 64 of file Info.h.

typedef std::map<std::string, OutputPortPtr> cca::ComponentInfo::NamedOutputPorts

Definition at line 66 of file Info.h.

---

Constructor & Destructor Documentation

cca::ComponentInfo::ComponentInfo

(

const std::string &

name

)

Constructor.

Definition at line 39 of file Info.cpp.

cca::ComponentInfo::~ComponentInfo

(

)

[virtual]

Definition at line 44 of file Info.cpp.

---

Member Function Documentation

void cca::ComponentInfo::displayBeatPort

(

InputPort< cca::timing::Tick >::Ptr

inputPort

)

Definition at line 171 of file Info.cpp.

References beatPortsCache, line(), and cca::InputPort< DATATYPE >::print().

Here is the call graph for this function:

void cca::ComponentInfo::displayComponentState

(

ComponentStatePtr

state

)

Definition at line 194 of file Info.cpp.

References line(), and stateCache.

Here is the call graph for this function:

void cca::ComponentInfo::displayDataPorts	(	NamedInputPorts	inputPorts,
		NamedOutputPorts	outputPorts
	)

Definition at line 131 of file Info.cpp.

References dataPortsCache, and line().

Here is the call graph for this function:

void cca::ComponentInfo::displayProperties	(	const rsc::runtime::Properties &	d,
		const rsc::runtime::Properties &	p
	)

Definition at line 205 of file Info.cpp.

References line(), and propertiesCache.

Here is the call graph for this function:

void cca::ComponentInfo::displayStatePorts	(	InputPort< ComponentState >::Ptr	inputPort,
		OutputPort< ComponentState >::Ptr	outputPort
	)

Definition at line 160 of file Info.cpp.

References line(), cca::OutputPort< DATATYPE >::print(), cca::InputPort< DATATYPE >::print(), and statePortsCache.

Here is the call graph for this function:

void cca::ComponentInfo::displayStrategy

(

StrategyPtr

strategy

)

Definition at line 180 of file Info.cpp.

References line(), and strategyCache.

Here is the call graph for this function:

std::string cca::ComponentInfo::line	(	std::string	str,
		unsigned int	place = 0,
		bool	horizontal = false
	)		const [protected, virtual]

Definition at line 80 of file Info.cpp.

Referenced by displayBeatPort(), displayComponentState(), displayDataPorts(), displayProperties(), displayStatePorts(), displayStrategy(), and print().

Here is the caller graph for this function:

std::string cca::ComponentInfo::print

(

)

const [virtual]

Prints the ComponentInfo.

Returns:

Formatted component information box

Reimplemented from cca::DataTransferObject.

Definition at line 47 of file Info.cpp.

References beatPortsCache, dataPortsCache, line(), name, propertiesCache, stateCache, statePortsCache, and strategyCache.

Here is the call graph for this function:

---

Member Data Documentation

std::string cca::ComponentInfo::beatPortsCache

Definition at line 97 of file Info.h.

Referenced by displayBeatPort(), and print().

std::string cca::ComponentInfo::dataPortsCache

Definition at line 97 of file Info.h.

Referenced by displayDataPorts(), and print().

std::string cca::ComponentInfo::name

Definition at line 94 of file Info.h.

Referenced by print().

std::string cca::ComponentInfo::propertiesCache

Definition at line 98 of file Info.h.

Referenced by displayProperties(), and print().

std::string cca::ComponentInfo::stateCache

Definition at line 95 of file Info.h.

Referenced by displayComponentState(), and print().

std::string cca::ComponentInfo::statePortsCache

Definition at line 97 of file Info.h.

Referenced by displayStatePorts(), and print().

std::string cca::ComponentInfo::strategyCache

Definition at line 96 of file Info.h.

Referenced by displayStrategy(), and print().

---

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

• cca/component/Info.h
• cca/component/Info.cpp