PandA-2024.02
Public Member Functions
data_o Class Reference

This class describes a generic data declaration object. More...

#include <structural_objects.hpp>

Inheritance diagram for data_o:
Inheritance graph
[legend]
Collaboration diagram for data_o:
Collaboration graph
[legend]

Public Member Functions

 data_o (int debug_level, const structural_objectRef o)
 Constructor. More...
 
 ~data_o () override=default
 destructor More...
 
void copy (structural_objectRef dest) const override
 Perform a copy of the data. More...
 
structural_objectRef find_member (const std::string &id, so_kind type, const structural_objectRef owner) const override
 Return the object named id of a given type which belongs to or it is associated with the object. More...
 
structural_objectRef find_isomorphic (const structural_objectRef key) const override
 Find key in this object. More...
 
void xload (const xml_element *Enode, structural_objectRef owner, structural_managerRef const &CM) override
 Load a structural_object starting from an xml file. More...
 
void xwrite (xml_element *rootnode) override
 Add a structural_object to an xml tree. More...
 
void print (std::ostream &os) const override
 Print the data declaration object (for debug purpose). More...
 
- Public Member Functions inherited from structural_object
 structural_object (int debug_level, const structural_objectRef o)
 Constructor for the structural_object. More...
 
virtual ~structural_object ()=default
 virtual destructor More...
 
const structural_objectRef get_owner () const
 Return the owner. More...
 
void set_owner (const structural_objectRef new_owner)
 set the owner of the structural object More...
 
void set_treenode (unsigned int n)
 Set the treenode id associated with the structural_object. More...
 
unsigned int get_treenode () const
 Return the treenode id associated with the structural_object. More...
 
void set_id (const std::string &s)
 Set the identifier associated with the structural_object. More...
 
const std::string & get_id () const
 Return the identifier associated with the structural_object. More...
 
void set_type (const structural_type_descriptorRef &s)
 Set the type of the structural_object. More...
 
const structural_type_descriptorRefget_typeRef () const
 Return the type descriptor of the structural_object. More...
 
void type_resize (unsigned long long new_bit_size)
 Just resize the size of the bits of the object. More...
 
void type_resize (unsigned long long new_bit_size, unsigned long long new_vec_size)
 resizing of vector objects More...
 
void set_black_box (bool bb)
 Set the black box property associated with the structural_object. More...
 
bool get_black_box () const
 Return the black box property. More...
 
void SetParameter (const std::string &name, const std::string &value)
 Set a parameter value. More...
 
bool ExistsParameter (std::string name) const
 Check if a parameter has been specified. More...
 
std::string GetParameter (std::string name) const
 Get the value associated to parameter if it has been associated; if it has not specified returns the default. More...
 
std::string GetDefaultParameter (std::string name) const
 Get the value associated to parameter if it has been associate; It throws an exception if it has not been associated. More...
 
CustomMap< std::string, std::string > GetParameters () const
 return the whole set of parameters More...
 
virtual void AddParameter (const std::string &name, const std::string &default_value)
 Add a parameter. More...
 
const std::string get_path () const
 Return a unique identifier of the structural object. More...
 
virtual std::string get_kind_text () const =0
 Virtual function used to get the string name of a structural_object instance. More...
 
virtual enum so_kind get_kind () const =0
 Virtual function used to find the real type of a structural_object instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from structural_object
std::string convert_so_short (so_kind in) const
 Convert a so_kind in a short string. More...
 
- Protected Attributes inherited from structural_object
friend structural_manager
 
int debug_level
 debug level for the object More...
 
- Static Protected Attributes inherited from structural_object
static simple_indent PP
 pretty print functor object used by all print members to indent the output of the print function. More...
 

Detailed Description

This class describes a generic data declaration object.

Definition at line 1227 of file structural_objects.hpp.

Constructor & Destructor Documentation

◆ data_o()

data_o::data_o ( int  debug_level,
const structural_objectRef  o 
)

Constructor.

Parameters
ois the owner of the data declaration object.

Definition at line 1950 of file structural_objects.cpp.

◆ ~data_o()

data_o::~data_o ( )
overridedefault

destructor

Member Function Documentation

◆ copy()

void data_o::copy ( structural_objectRef  dest) const
overridevirtual

Perform a copy of the data.

Parameters
destdestination object.

Reimplemented from structural_object.

Definition at line 1960 of file structural_objects.cpp.

References structural_object::copy().

Here is the call graph for this function:

◆ find_isomorphic()

structural_objectRef data_o::find_isomorphic ( const structural_objectRef  key) const
overridevirtual

Find key in this object.

Parameters
keyis the object searched.

Implements structural_object.

Definition at line 1965 of file structural_objects.cpp.

References THROW_ERROR.

◆ find_member()

structural_objectRef data_o::find_member ( const std::string &  id,
so_kind  type,
const structural_objectRef  owner 
) const
overridevirtual

Return the object named id of a given type which belongs to or it is associated with the object.

This method throw and error since does not have associated any structural object.

Parameters
idis the identifier of the object we are looking for.
typeis the type of the object we are looking for.
owneris the owner of the object named id.

Implements structural_object.

Definition at line 1954 of file structural_objects.cpp.

References THROW_ERROR.

◆ print()

void data_o::print ( std::ostream &  os) const
overridevirtual

Print the data declaration object (for debug purpose).

Parameters
osis an output stream.

Reimplemented from structural_object.

Definition at line 1982 of file structural_objects.cpp.

References structural_object::PP, and structural_object::print().

Here is the call graph for this function:

◆ xload()

void data_o::xload ( const xml_element Enode,
structural_objectRef  owner,
structural_managerRef const &  CM 
)
overridevirtual

Load a structural_object starting from an xml file.

Parameters
nodeis a node of the xml tree.
owneris the refcount version of this.
CMis the circuit manager.

Reimplemented from structural_object.

Definition at line 1971 of file structural_objects.cpp.

References structural_object::xload().

Here is the call graph for this function:

◆ xwrite()

void data_o::xwrite ( xml_element rootnode)
overridevirtual

Add a structural_object to an xml tree.

Parameters
rootnodeis the root node at which the xml representation of the structural object is attached.

Reimplemented from structural_object.

Definition at line 1976 of file structural_objects.cpp.

References xml_child::add_child_element(), structural_object::get_kind_text(), and structural_object::xwrite().

Here is the call graph for this function:

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

Generated on Mon Feb 12 2024 13:03:49 for PandA-2024.02 by doxygen 1.8.13