scc::cci_param_restricted< T, TM > Struct Template Reference

extension of cci_param<T, TM> which automatically registeres a callback to restrict the valid values given to the parameter. More...

#include <cci_param_restricted.h>

Inheritance diagram for scc::cci_param_restricted< T, TM >:

Collaboration diagram for scc::cci_param_restricted< T, TM >:

Public Member Functions
Constructors
template<typename RESTR >
	cci_param_restricted (const std::string &name, const T &default_value, RESTR const &restr, const std::string &desc="", cci::cci_name_type name_type=cci::CCI_RELATIVE_NAME, const cci::cci_originator &originator=sc_core::sc_get_current_object() ? cci::cci_originator() :cci::cci_originator("sc_main"))
template<typename RESTR >
	cci_param_restricted (const std::string &name, const T &default_value, RESTR const &restr, cci::cci_broker_handle private_broker, const std::string &desc="", cci::cci_name_type name_type=cci::CCI_RELATIVE_NAME, const cci::cci_originator &originator=sc_core::sc_get_current_object() ? cci::cci_originator() :cci::cci_originator("sc_main"))

Detailed Description

template<typename T, cci::cci_param_mutable_type TM = cci::CCI_MUTABLE_PARAM>
struct scc::cci_param_restricted< T, TM >

extension of cci_param<T, TM> which automatically registeres a callback to restrict the valid values given to the parameter.

The parameter can be use with a restriction created by:

• min_max_restriction(T min, T max)
• min_max_excl_restriction(T min, T max)
• min_restriction(T min), gte_restriction(T min)
• min_excl_restriction(T min), gt_excl_restriction(T min)
• max_restriction(T max), lte_restriction(T max)
• max_excl_restriction(T max), lt_excl_restriction(T max)
• discrete_restriction(std::initializer_list<T> values), discrete_restriction(std::array<T, SZ> values), discrete_restriction(std::vector<T> values)

Template Parameters

T	type of the parameter value
TM	specifies the parameter type lock behavior

Definition at line 196 of file cci_param_restricted.h.

Constructor & Destructor Documentation

cci_param_restricted() [1/2]

template<typename T , cci::cci_param_mutable_type TM = cci::CCI_MUTABLE_PARAM>

template<typename RESTR >

scc::cci_param_restricted< T, TM >::cci_param_restricted ( const std::string &  name, const T &  default_value, RESTR const &  restr, const std::string &  desc = "", cci::cci_name_type  name_type = cci::CCI_RELATIVE_NAME, const cci::cci_originator &  originator = sc_core::sc_get_current_object() ? cci::cci_originator() : cci::cci_originator("sc_main")  )

inline

Constructor with (local/hierarchical) name, default value, restriction, description and originator.

Parameters

name	Name of the parameter
default_value	Default value of the parameter (Typed value)
restr	Restriction to apply, will be checked befor every write
desc	Description of the parameter
name_type	Either the name should be absolute or relative
originator	Originator of the parameter

Definition at line 212 of file cci_param_restricted.h.

cci_param_restricted() [2/2]

template<typename T , cci::cci_param_mutable_type TM = cci::CCI_MUTABLE_PARAM>

template<typename RESTR >

scc::cci_param_restricted< T, TM >::cci_param_restricted ( const std::string &  name, const T &  default_value, RESTR const &  restr, cci::cci_broker_handle  private_broker, const std::string &  desc = "", cci::cci_name_type  name_type = cci::CCI_RELATIVE_NAME, const cci::cci_originator &  originator = sc_core::sc_get_current_object() ? cci::cci_originator() : cci::cci_originator("sc_main")  )

inline

Constructor with (local/hierarchical) name, default value, restriction, private broker, description, name type and originator.

Parameters

name	Name of the parameter
default_value	Default value of the parameter (Typed value)
private_broker	Associated private broker
restr	Restriction to apply, will be checked befor every write
desc	Description of the parameter
name_type	Either the name should be absolute or relative
originator	Originator of the parameter

Definition at line 234 of file cci_param_restricted.h.

---

The documentation for this struct was generated from the following file:

• /home/eyck/git/SystemC-Components/src/sysc/scc/cci_param_restricted.h