scc  2022.4.0
SystemC components library
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=cci::cci_originator())
 
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=cci::cci_originator())
 

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.

Template Parameters
Ttype of the parameter value
TMspecifies the parameter type lock behavior

Definition at line 180 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 = cci::cci_originator() 
)
inline

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

Parameters
nameName of the parameter
default_valueDefault value of the parameter (Typed value)
restrRestriction to apply, will be checked befor every write
descDescription of the parameter
name_typeEither the name should be absolute or relative
originatorOriginator of the parameter

Definition at line 196 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 = cci::cci_originator() 
)
inline

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

Parameters
nameName of the parameter
default_valueDefault value of the parameter (Typed value)
private_brokerAssociated private broker
restrRestriction to apply, will be checked befor every write
descDescription of the parameter
name_typeEither the name should be absolute or relative
originatorOriginator of the parameter

Definition at line 217 of file cci_param_restricted.h.


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