TracePlugin Struct Reference

The private interface of class TracePlugin. More...

#include <TracePlugin_private.h>

Public Member Functions
	INHERITS_FROM (Object)
Data Fields
VIRTUAL int(*	action )(const TracePlugin_ptr self)
NodeAnonymizerBase_ptr	anonymizer
char *	desc
TraceOpt_ptr	opt
VIRTUAL void(*	print_assignment )(const TracePlugin_ptr self, node_ptr symbol, node_ptr val)
VIRTUAL void(*	print_list )(const TracePlugin_ptr self, node_ptr list)
VIRTUAL void(*	print_symbol )(const TracePlugin_ptr self, node_ptr symbol)
Trace_ptr	trace
hash_ptr	visibility_map
Related Functions
(Note that these are not member functions.)
int	trace_plugin_action (const TracePlugin_ptr self)
	Action associated with the Class action.
void	trace_plugin_deinit (TracePlugin_ptr self)
	This function de-initializes the plugin class.
void	trace_plugin_init (TracePlugin_ptr self, char *desc)
	This function initializes the plugin class.
boolean	trace_plugin_is_visible_symbol (TracePlugin_ptr self, node_ptr symb)
	Check that node is printable.
void	trace_plugin_print_assignment (const TracePlugin_ptr self, node_ptr symb, node_ptr val)
void	trace_plugin_print_list (const TracePlugin_ptr self, node_ptr list)
void	trace_plugin_print_symbol (const TracePlugin_ptr self, node_ptr symbol)
VIRTUAL int	TracePlugin_action (const TracePlugin_ptr self, const Trace_ptr trace, const TraceOpt_ptr opt)
	Action associated with the Class TracePlugin.
char *	TracePlugin_get_desc (const TracePlugin_ptr self)
	Returns a short description of the plugin.
VIRTUAL void	TracePlugin_print_assignment (const TracePlugin_ptr self, node_ptr symb, node_ptr val)
VIRTUAL void	TracePlugin_print_list (const TracePlugin_ptr self, node_ptr list)
VIRTUAL void	TracePlugin_print_symbol (const TracePlugin_ptr self, node_ptr symb)

---

Detailed Description

The private interface of class TracePlugin.

The header file for the TracePlugin class.

Author:

Ashutosh Trivedi Private definition to be used by derived classes

TracePlugin Class This class defines a prototype for a generic TracePlugin. This class is virtual and must be specialized.

Author:

Ashutosh Trivedi This Class implements a generic Plugin class.

Todo:

Missing synopsis

Todo:

Missing description

---

Member Function Documentation

TracePlugin::INHERITS_FROM

(

Object

)

---

Friends And Related Function Documentation

int trace_plugin_action

(

const TracePlugin_ptr

self

)

[related]

Action associated with the Class action.

It is a pure virtual function and TracePlugin is an abstract base class. Every derived class must ovewrwrite this function. It returns 1 if operation is successful, 0 otherwise. MD: This is not true at least for trace_explainer

void trace_plugin_deinit

(

TracePlugin_ptr

self

)

[related]

This function de-initializes the plugin class.

void trace_plugin_init	(	TracePlugin_ptr	self,
		char *	desc
	)			[related]

This function initializes the plugin class.

boolean trace_plugin_is_visible_symbol	(	TracePlugin_ptr	self,
		node_ptr	symb
	)			[related]

Check that node is printable.

void trace_plugin_print_assignment	(	const TracePlugin_ptr	self,
		node_ptr	symb,
		node_ptr	val
	)			[related]

void trace_plugin_print_list	(	const TracePlugin_ptr	self,
		node_ptr	list
	)			[related]

void trace_plugin_print_symbol	(	const TracePlugin_ptr	self,
		node_ptr	symbol
	)			[related]

VIRTUAL int TracePlugin_action	(	const TracePlugin_ptr	self,
		const Trace_ptr	trace,
		const TraceOpt_ptr	opt
	)			[related]

Action associated with the Class TracePlugin.

AutomaticStart

Executes the different action method, corresponding to which derived class instance belongs to, on the trace.

The return value is -1 in case of error.

char * TracePlugin_get_desc

(

const TracePlugin_ptr

self

)

[related]

Returns a short description of the plugin.

VIRTUAL void TracePlugin_print_assignment	(	const TracePlugin_ptr	self,
		node_ptr	symb,
		node_ptr	val
	)			[related]

VIRTUAL void TracePlugin_print_list	(	const TracePlugin_ptr	self,
		node_ptr	list
	)			[related]

VIRTUAL void TracePlugin_print_symbol	(	const TracePlugin_ptr	self,
		node_ptr	symb
	)			[related]

AutomaticStart

---

Field Documentation

VIRTUAL int(* TracePlugin::action)(const TracePlugin_ptr self)

NodeAnonymizerBase_ptr TracePlugin::anonymizer

char* TracePlugin::desc

TraceOpt_ptr TracePlugin::opt

VIRTUAL void(* TracePlugin::print_assignment)(const TracePlugin_ptr self, node_ptr symbol, node_ptr val)

VIRTUAL void(* TracePlugin::print_list)(const TracePlugin_ptr self, node_ptr list)

VIRTUAL void(* TracePlugin::print_symbol)(const TracePlugin_ptr self, node_ptr symbol)

Trace_ptr TracePlugin::trace

hash_ptr TracePlugin::visibility_map

---

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

• NuSMV/code/nusmv/core/trace/plugins/TracePlugin_private.h
• NuSMV/code/nusmv/core/trace/plugins/TracePlugin.h