ppap4lmp  0.7.2
StaCopy Class Reference

StaCopy copies Element::data of an existing Element object and sets it to a new Element object. More...

#include <sta_copy.h>

Inheritance diagram for StaCopy:
Collaboration diagram for StaCopy:

Public Member Functions

 StaCopy (const ElPtr &elem)
 Constructor of StaCopy class. More...
 
- Public Member Functions inherited from Starter
 Updater ()=default
 Constructor of Updater class. More...
 
- Public Member Functions inherited from Updater
 Updater ()=default
 Constructor of Updater class. More...
 
void compute (const ElPtr &elem, const int elementid, Json &data)
 Managing computation to update Element::data. More...
 
void remove_from_skippable_elementids (const int elementid)
 Remove Element::elementid from skippable_elementids. More...
 
const ShPtr< Generator > & get_ext_generator ()
 Get ext_generator of this object. More...
 

Protected Member Functions

virtual void compute_impl (Json &data, JsonToVoidFunc check_required_keys, JsonToBoolFunc check_optional_keys) override
 This method overrides Updater::compute_impl.
 
- Protected Member Functions inherited from Starter
virtual void compute_body (const ElPtr &elem, Json &data) override
 Compute or parse properties and set them to Element::data given as a mutable reference. More...
 
- Protected Member Functions inherited from Updater
virtual void compute_common (const ElPtr &elem, Json &data)
 Common part of compute_body. More...
 

Static Protected Attributes

static const bool do_sorting_by_id = false
 
- Static Protected Attributes inherited from Starter
static const bool do_sorting_by_id = true
 

Additional Inherited Members

- Protected Attributes inherited from Updater
ShPtr< Generatorext_generator
 

Detailed Description

StaCopy copies Element::data of an existing Element object and sets it to a new Element object.

An object of this class owns an existing Element object as ext_generator and copies Element::data of the existing object, and then sets the copies to a new Element object.

About usage in Python, please see pybind::py_sta_copy.

Definition at line 25 of file sta_copy.h.

Constructor & Destructor Documentation

◆ StaCopy()

StaCopy::StaCopy ( const ElPtr elem)

Constructor of StaCopy class.

Parameters
elemAn Element object to be copied. This parameter is assigned to ext_generator.

Definition at line 16 of file sta_copy.cpp.

Member Data Documentation

◆ do_sorting_by_id

const bool StaCopy::do_sorting_by_id = false
staticprotected

Whether to call sort_by_id after setting data.

Definition at line 28 of file sta_copy.h.


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