Nemiver  0.3
Public Member Functions | Protected Member Functions | List of all members
nemiver::IVarList Class Referenceabstract

#include <nmv-i-var-list.h>

Inheritance diagram for nemiver::IVarList:
nemiver::common::DynModIface nemiver::common::Object

Public Member Functions

virtual void initialize (IDebuggerSafePtr &a_debugger)=0
 intialize the interface with a given IDebugger pointer. This must be the function called on the interface before using it. Failing to initialize the interface with a valid non null IDebugger make subsequent invocation of the interface methods throw instances of nemiver::common::Exception. More...
 
virtual IDebuggerget_debugger () const =0
 
virtual const DebuggerVariableListget_raw_list () const =0
 
virtual void append_variable (const IDebugger::VariableSafePtr &a_var, bool a_update_type=true)=0
 append a variable to the list More...
 
virtual void append_variables (const DebuggerVariableList &a_vars, bool a_update_type=true)=0
 append a set list of variables to the list More...
 
virtual bool remove_variable (const IDebugger::VariableSafePtr &a_var)=0
 remove a variable from the list More...
 
virtual bool remove_variable (const UString &a_var_name)=0
 remove a variable from the list More...
 
virtual void remove_variables ()=0
 remove all variables from the list More...
 
virtual bool find_variable (const UString &a_var_name, IDebugger::VariableSafePtr &a_var)=0
 lookup a variable from its name More...
 
virtual bool find_variable_from_qname (const UString &a_qname, IDebugger::VariableSafePtr &a_var)=0
 get the variable addressed by a qualified variable name. More...
 
virtual void update_state ()=0
 update the state of the all the variables of the list More...
 
signals
virtual sigc::signal< void, const IDebugger::VariableSafePtr & > & variable_added_signal ()=0
 
virtual sigc::signal< void, const IDebugger::VariableSafePtr > & variable_value_set_signal ()=0
 
virtual sigc::signal< void, const IDebugger::VariableSafePtr & > & variable_type_set_signal ()=0
 
virtual sigc::signal< void, const IDebugger::VariableSafePtr & > & variable_removed_signal ()=0
 
- Public Member Functions inherited from nemiver::common::DynModIface
 DynModIface (DynamicModuleSafePtr &a_dynmod)
 
 DynModIface (DynamicModule *a_dynmod)
 
DynamicModuleget_dynamic_module () const
 
- Public Member Functions inherited from nemiver::common::Object
 Object ()
 
 Object (Object const &)
 
Objectoperator= (Object const &)
 
virtual ~Object ()
 
void ref ()
 
void unref ()
 
void enable_refcount (bool a_enabled=true)
 
bool is_refcount_enabled () const
 
long get_refcount () const
 
void attach_object (const UString &a_key, const Object *a_object)
 
bool get_attached_object (const UString &a_key, const Object *&a_object)
 

Protected Member Functions

 IVarList (DynamicModule *a_dynmod)
 

Additional Inherited Members

- Protected Attributes inherited from nemiver::common::Object
SafePtr< ObjectPrivm_priv
 

Constructor & Destructor Documentation

◆ IVarList()

nemiver::IVarList::IVarList ( DynamicModule a_dynmod)
inlineprotected

Member Function Documentation

◆ append_variable()

virtual void nemiver::IVarList::append_variable ( const IDebugger::VariableSafePtr a_var,
bool  a_update_type = true 
)
pure virtual

append a variable to the list

Parameters
a_varthe new variable to append
a_update_typeif true, update the type field of the the variable. This will trigger an invocation of the IDebugger interface.

◆ append_variables()

virtual void nemiver::IVarList::append_variables ( const DebuggerVariableList a_vars,
bool  a_update_type = true 
)
pure virtual

append a set list of variables to the list

Parameters
a_varsthe new variable list to append
a_update_typeif true, update the type field of the the variable. This will trigger an invocation of the IDebugger interface.

◆ find_variable()

virtual bool nemiver::IVarList::find_variable ( const UString a_var_name,
IDebugger::VariableSafePtr a_var 
)
pure virtual

lookup a variable from its name

Parameters
a_var_namethe name of the variable to look for
a_varwhere to put the variable, if found.
Returns
true if the variable were found, false otherwise.

◆ find_variable_from_qname()

virtual bool nemiver::IVarList::find_variable_from_qname ( const UString a_qname,
IDebugger::VariableSafePtr a_var 
)
pure virtual

get the variable addressed by a qualified variable name.

a qualified variable name has a form similar to: foo.bar.baz

Parameters
a_qnamethe qualified variable name
a_varout parameters. The resulting variable, if found.
Returns
true if the a variable matching that the qname a_qname has been found, false otherwise.

◆ get_debugger()

virtual IDebugger& nemiver::IVarList::get_debugger ( ) const
pure virtual

◆ get_raw_list()

virtual const DebuggerVariableList& nemiver::IVarList::get_raw_list ( ) const
pure virtual
Returns
the raw list of variables maintained internally.

◆ initialize()

virtual void nemiver::IVarList::initialize ( IDebuggerSafePtr a_debugger)
pure virtual

intialize the interface with a given IDebugger pointer. This must be the function called on the interface before using it. Failing to initialize the interface with a valid non null IDebugger make subsequent invocation of the interface methods throw instances of nemiver::common::Exception.

Parameters
a_debuggerthe non null debugger interface used to query

◆ remove_variable() [1/2]

virtual bool nemiver::IVarList::remove_variable ( const IDebugger::VariableSafePtr a_var)
pure virtual

remove a variable from the list

Parameters
a_varthe variable to remove from the list
Returns
true if the variable has been found and removed

◆ remove_variable() [2/2]

virtual bool nemiver::IVarList::remove_variable ( const UString a_var_name)
pure virtual

remove a variable from the list

Parameters
a_var_namethe name of the variable to remove
Returns
true if the variable has been found and removed

◆ remove_variables()

virtual void nemiver::IVarList::remove_variables ( )
pure virtual

remove all variables from the list

◆ update_state()

virtual void nemiver::IVarList::update_state ( )
pure virtual

update the state of the all the variables of the list

issue many calls to the underlying IDebugger interface to query the new values of variables contained in the list

◆ variable_added_signal()

virtual sigc::signal<void, const IDebugger::VariableSafePtr&>& nemiver::IVarList::variable_added_signal ( )
pure virtual

◆ variable_removed_signal()

virtual sigc::signal<void, const IDebugger::VariableSafePtr&>& nemiver::IVarList::variable_removed_signal ( )
pure virtual

◆ variable_type_set_signal()

virtual sigc::signal<void, const IDebugger::VariableSafePtr&>& nemiver::IVarList::variable_type_set_signal ( )
pure virtual

◆ variable_value_set_signal()

virtual sigc::signal<void, const IDebugger::VariableSafePtr>& nemiver::IVarList::variable_value_set_signal ( )
pure virtual

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