sc_core::sc_port_base Class Reference

#include <sysc/communication/sc_port.h>

Inheritance diagram for sc_core::sc_port_base:

Collaboration diagram for sc_core::sc_port_base:

List of all members.

Public Types

typedef sc_port_base this_type

Public Member Functions

virtual sc_interface * get_interface ()=0

get the first interface without checking for nil

virtual const sc_interface * get_interface () const =0

get the first interface without checking for nil

virtual const char * kind () const

const char * name () const

return full name of sc_object

const char * basename () const

return base name of sc_object (last part)

virtual void print (::std::ostream &os=::std::cout) const

print object

virtual void dump (::std::ostream &os=::std::cout) const

dump() is more detailed than print()

virtual void trace (sc_trace_file *tf) const

sc_simcontext * simcontext () const

bool add_attribute (sc_attr_base &)

add attribute

sc_attr_base * get_attribute (const std::string &name_)

get attribute by name

const sc_attr_base * get_attribute (const std::string &name_) const

get attribute by name

sc_attr_base * remove_attribute (const std::string &name_)

remove attribute by name

void remove_all_attributes ()

remove all attributes

int num_attributes () const

get the number of attributes

sc_attr_cltn & attr_cltn ()

get the attribute collection

const sc_attr_cltn & attr_cltn () const

get the attribute collection

virtual const std::vector
< sc_object * > & get_child_objects () const

return child objects

sc_object * get_parent () const

return parent object

sc_object * get_parent_object () const

return parent object

Protected Member Functions

sc_port_base (int max_size_, sc_port_policy policy=SC_ONE_OR_MORE_BOUND)

constructors

sc_port_base (const char *name_, int max_size_, sc_port_policy policy=SC_ONE_OR_MORE_BOUND)

virtual ~sc_port_base ()

destructor

void bind (sc_interface &interface_)

bind interface to this port

void bind (this_type &parent_)

bind parent port to this port

virtual int vbind (sc_interface &)=0

called by pbind (for internal use only)

virtual int vbind (sc_port_base &)=0

virtual void add_interface (sc_interface *)=0

virtual int interface_count ()=0

virtual const char * if_typename () const =0

virtual void before_end_of_elaboration ()

called by construction_done (does nothing by default)

virtual void end_of_elaboration ()

called by elaboration_done (does nothing)

virtual void start_of_simulation ()

called by start_simulation (does nothing by default)

virtual void end_of_simulation ()

called by simulation_done (does nothing by default)

void report_error (const char *id, const char *add_msg=0) const

error reporting

virtual void make_sensitive (sc_thread_handle, sc_event_finder *=0) const

called by the sc_sensitive* classes

virtual void make_sensitive (sc_method_handle, sc_event_finder *=0) const

void add_static_event (sc_method_handle process_p, const sc_event &event) const

void add_static_event (sc_thread_handle process_p, const sc_event &event) const

Protected Attributes

sc_bind_info * m_bind_info

Friends

class sc_module

class sc_port_registry

class sc_sensitive

class sc_sensitive_pos

class sc_sensitive_neg

Detailed Description

Definition at line 114 of file sc_port.h.

Member Typedef Documentation

typedef sc_port_base sc_core::sc_port_base::this_type

Definition at line 127 of file sc_port.h.

Constructor & Destructor Documentation

sc_core::sc_port_base::sc_port_base	(	int	max_size_,
		sc_port_policy	policy = `SC_ONE_OR_MORE_BOUND`
	)			`[explicit, protected]`

constructors

Definition at line 271 of file sc_port.cpp.

sc_core::sc_port_base::sc_port_base	(	const char *	name_,
		int	max_size_,
		sc_port_policy	policy = `SC_ONE_OR_MORE_BOUND`
	)			`[protected]`

Definition at line 280 of file sc_port.cpp.

sc_core::sc_port_base::~sc_port_base ( ) [protected, virtual]

destructor

Definition at line 292 of file sc_port.cpp.

Member Function Documentation

virtual sc_interface* sc_core::sc_port_base::get_interface ( ) [pure virtual]

get the first interface without checking for nil

virtual const sc_interface* sc_core::sc_port_base::get_interface ( ) const [pure virtual]

get the first interface without checking for nil

virtual const char* sc_core::sc_port_base::kind ( ) const [inline, virtual]

Reimplemented from sc_core::sc_object.

Definition at line 136 of file sc_port.h.

void sc_core::sc_port_base::bind ( sc_interface & interface_ ) [protected]

bind interface to this port

Definition at line 304 of file sc_port.cpp.

void sc_core::sc_port_base::bind ( this_type & parent_ ) [protected]

bind parent port to this port

Definition at line 324 of file sc_port.cpp.

virtual int sc_core::sc_port_base::vbind ( sc_interface & ) [protected, pure virtual]

called by pbind (for internal use only)

virtual int sc_core::sc_port_base::vbind ( sc_port_base & ) [protected, pure virtual]

virtual void sc_core::sc_port_base::add_interface ( sc_interface * ) [protected, pure virtual]

virtual int sc_core::sc_port_base::interface_count ( ) [protected, pure virtual]

virtual const char* sc_core::sc_port_base::if_typename ( ) const [protected, pure virtual]

void sc_core::sc_port_base::before_end_of_elaboration ( ) [protected, virtual]

called by construction_done (does nothing by default)

Definition at line 351 of file sc_port.cpp.

void sc_core::sc_port_base::end_of_elaboration ( ) [protected, virtual]

called by elaboration_done (does nothing)

Reimplemented in sc_core::sc_in< T >, sc_core::sc_core::sc_in< bool >, sc_core::sc_core::sc_in< sc_dt::sc_logic >, sc_core::sc_inout< T >, sc_core::sc_core::sc_inout< bool >, sc_core::sc_core::sc_inout< sc_dt::sc_logic >, sc_core::sc_in_resolved, sc_core::sc_inout_resolved, sc_core::sc_in_rv< W >, sc_core::sc_inout_rv< W >, sc_core::sc_in< sc_dt::sc_lv< W > >, and sc_core::sc_inout< sc_dt::sc_lv< W > >.

Definition at line 357 of file sc_port.cpp.

void sc_core::sc_port_base::start_of_simulation ( ) [protected, virtual]

called by start_simulation (does nothing by default)

Definition at line 362 of file sc_port.cpp.

void sc_core::sc_port_base::end_of_simulation ( ) [protected, virtual]

called by simulation_done (does nothing by default)

Definition at line 367 of file sc_port.cpp.

void sc_core::sc_port_base::report_error	(	const char *	id,
		const char *	add_msg = `0`
	)			const `[protected]`

error reporting

Definition at line 257 of file sc_port.cpp.

void sc_core::sc_port_base::make_sensitive	(	sc_thread_handle	handle_,
		sc_event_finder *	event_finder_ = `0`
	)			const `[protected, virtual]`

called by the sc_sensitive* classes

Definition at line 409 of file sc_port.cpp.

void sc_core::sc_port_base::make_sensitive	(	sc_method_handle	handle_,
		sc_event_finder *	event_finder_ = `0`
	)			const `[protected, virtual]`

Definition at line 418 of file sc_port.cpp.

void sc_core::sc_port_base::add_static_event	(	sc_method_handle	process_p,
		const sc_event &	event
	)			const `[protected]`

Definition at line 241 of file sc_port.cpp.

void sc_core::sc_port_base::add_static_event	(	sc_thread_handle	process_p,
		const sc_event &	event
	)			const `[protected]`

Definition at line 247 of file sc_port.cpp.

const char* sc_core::sc_object::name ( ) const [inline, inherited]

return full name of sc_object

Definition at line 80 of file sc_object.h.

const char * sc_core::sc_object::basename ( ) const [inherited]

return base name of sc_object (last part)

Definition at line 95 of file sc_object.cpp.

void sc_core::sc_object::print ( ::std::ostream & os = ::std::cout ) const [virtual, inherited]

print object

Reimplemented in sc_core::sc_fifo< T >, sc_core::sc_signal< T >, sc_core::sc_core::sc_signal< bool >, sc_core::sc_core::sc_signal< sc_dt::sc_logic >, and sc_core::sc_signal< sc_dt::sc_lv< W > >.

Definition at line 102 of file sc_object.cpp.

void sc_core::sc_object::dump ( ::std::ostream & os = ::std::cout ) const [virtual, inherited]

dump() is more detailed than print()

Reimplemented in sc_core::sc_fifo< T >, sc_core::sc_signal< T >, sc_core::sc_core::sc_signal< bool >, sc_core::sc_core::sc_signal< sc_dt::sc_logic >, and sc_core::sc_signal< sc_dt::sc_lv< W > >.

Definition at line 108 of file sc_object.cpp.

void sc_core::sc_object::trace ( sc_trace_file * tf ) const [virtual, inherited]

Reimplemented in sc_core::sc_fifo< T >, sc_core::sc_signal< T >, sc_core::sc_core::sc_signal< bool >, sc_core::sc_core::sc_signal< sc_dt::sc_logic >, and sc_core::sc_signal< sc_dt::sc_lv< W > >.

Definition at line 302 of file sc_object.cpp.

sc_simcontext* sc_core::sc_object::simcontext ( ) const [inline, inherited]

Definition at line 95 of file sc_object.h.

bool sc_core::sc_object::add_attribute ( sc_attr_base & attribute_ ) [inherited]

add attribute

Definition at line 311 of file sc_object.cpp.

sc_attr_base * sc_core::sc_object::get_attribute ( const std::string & name_ ) [inherited]

get attribute by name

Definition at line 321 of file sc_object.cpp.

const sc_attr_base * sc_core::sc_object::get_attribute ( const std::string & name_ ) const [inherited]

get attribute by name

Definition at line 328 of file sc_object.cpp.

sc_attr_base * sc_core::sc_object::remove_attribute ( const std::string & name_ ) [inherited]

remove attribute by name

Definition at line 338 of file sc_object.cpp.

void sc_core::sc_object::remove_all_attributes ( ) [inherited]

remove all attributes

Definition at line 350 of file sc_object.cpp.

int sc_core::sc_object::num_attributes ( ) const [inherited]

get the number of attributes

Definition at line 360 of file sc_object.cpp.

sc_attr_cltn & sc_core::sc_object::attr_cltn ( ) [inherited]

get the attribute collection

Definition at line 372 of file sc_object.cpp.

const sc_attr_cltn & sc_core::sc_object::attr_cltn ( ) const [inherited]

get the attribute collection

Definition at line 379 of file sc_object.cpp.

virtual const std::vector<sc_object*>& sc_core::sc_object::get_child_objects ( ) const [inline, virtual, inherited]

return child objects

Reimplemented in sc_core::sc_module, and sc_core::sc_process_b.

Definition at line 121 of file sc_object.h.

sc_object* sc_core::sc_object::get_parent ( ) const [inline, inherited]

return parent object

Definition at line 125 of file sc_object.h.

sc_object* sc_core::sc_object::get_parent_object ( ) const [inline, inherited]

return parent object

Definition at line 127 of file sc_object.h.

Friends And Related Function Documentation

friend class sc_module [friend]

Definition at line 117 of file sc_port.h.

friend class sc_port_registry [friend]

Definition at line 118 of file sc_port.h.

friend class sc_sensitive [friend]

Definition at line 119 of file sc_port.h.

friend class sc_sensitive_pos [friend]

Definition at line 120 of file sc_port.h.

friend class sc_sensitive_neg [friend]

Definition at line 121 of file sc_port.h.

Member Data Documentation

sc_bind_info* sc_core::sc_port_base::m_bind_info [protected]

Definition at line 215 of file sc_port.h.

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

sysc/communication/sc_port.h
sysc/communication/sc_port.cpp


Public Types
typedef sc_port_base	this_type
Public Member Functions
virtual sc_interface *	get_interface ()=0
	get the first interface without checking for nil
virtual const sc_interface *	get_interface () const =0
	get the first interface without checking for nil
virtual const char *	kind () const
const char *	name () const
	return full name of sc_object
const char *	basename () const
	return base name of sc_object (last part)
virtual void	print (::std::ostream &os=::std::cout) const
	print object
virtual void	dump (::std::ostream &os=::std::cout) const
	dump() is more detailed than print()
virtual void	trace (sc_trace_file *tf) const
sc_simcontext *	simcontext () const
bool	add_attribute (sc_attr_base &)
	add attribute
sc_attr_base *	get_attribute (const std::string &name_)
	get attribute by name
const sc_attr_base *	get_attribute (const std::string &name_) const
	get attribute by name
sc_attr_base *	remove_attribute (const std::string &name_)
	remove attribute by name
void	remove_all_attributes ()
	remove all attributes
int	num_attributes () const
	get the number of attributes
sc_attr_cltn &	attr_cltn ()
	get the attribute collection
const sc_attr_cltn &	attr_cltn () const
	get the attribute collection
virtual const std::vector < sc_object * > &	get_child_objects () const
	return child objects
sc_object *	get_parent () const
	return parent object
sc_object *	get_parent_object () const
	return parent object
Protected Member Functions
	sc_port_base (int max_size_, sc_port_policy policy=SC_ONE_OR_MORE_BOUND)
	constructors
	sc_port_base (const char *name_, int max_size_, sc_port_policy policy=SC_ONE_OR_MORE_BOUND)
virtual	~sc_port_base ()
	destructor
void	bind (sc_interface &interface_)
	bind interface to this port
void	bind (this_type &parent_)
	bind parent port to this port
virtual int	vbind (sc_interface &)=0
	called by pbind (for internal use only)
virtual int	vbind (sc_port_base &)=0
virtual void	add_interface (sc_interface *)=0
virtual int	interface_count ()=0
virtual const char *	if_typename () const =0
virtual void	before_end_of_elaboration ()
	called by construction_done (does nothing by default)
virtual void	end_of_elaboration ()
	called by elaboration_done (does nothing)
virtual void	start_of_simulation ()
	called by start_simulation (does nothing by default)
virtual void	end_of_simulation ()
	called by simulation_done (does nothing by default)
void	report_error (const char id, const char add_msg=0) const
	error reporting
virtual void	make_sensitive (sc_thread_handle, sc_event_finder *=0) const
	called by the sc_sensitive* classes
virtual void	make_sensitive (sc_method_handle, sc_event_finder *=0) const
void	add_static_event (sc_method_handle process_p, const sc_event &event) const
void	add_static_event (sc_thread_handle process_p, const sc_event &event) const
Protected Attributes
sc_bind_info *	m_bind_info
Friends
class	sc_module
class	sc_port_registry
class	sc_sensitive
class	sc_sensitive_pos
class	sc_sensitive_neg