Three-dimensional array of object pointers. More...
#include <PtrArray3dBase.h>
Inheritance diagram for XC::PtrArray3dBase< PtrArray >:
Collaboration diagram for XC::PtrArray3dBase< PtrArray >:
Public Types | |
| typedef Array3dBase< PtrArray >::value_type | value_type |
| typedef Array3dBase< PtrArray >::iterator | iterator |
 Public Types inherited from Array3dBase< PtrArray > | |
| typedef PtrArray ::value_type | value_type |
| typedef PtrArray ::reference | reference |
| typedef PtrArray ::const_reference | const_reference |
| typedef std::vector< PtrArray >::value_type | matrix_type |
| typedef std::vector< PtrArray >::iterator | iterator |
| typedef std::vector< PtrArray >::const_iterator | const_iterator |
| typedef Array3dBoxConstRef< Array3dBase< PtrArray > > | box_const_ref |
| typedef ConstantILayerConstRef< Array3dBase< PtrArray > > | constant_i_layer_const_ref |
| typedef ConstantJLayerConstRef< Array3dBase< PtrArray > > | constant_j_layer_const_ref |
| typedef ConstantKLayerConstRef< Array3dBase< PtrArray > > | constant_k_layer_const_ref |
| typedef IRowConstRef< Array3dBase< PtrArray > > | const_ref_i_row |
| typedef JRowConstRef< Array3dBase< PtrArray > > | const_ref_j_row |
| typedef KRowConstRef< Array3dBase< PtrArray > > | const_ref_k_row |
| typedef Array3dBoxVarRef< Array3dBase< PtrArray > > | box_var_ref |
| typedef ConstantILayerVarRef< Array3dBase< PtrArray > > | constant_i_layer_variable_ref |
| typedef ConstantJLayerVarRef< Array3dBase< PtrArray > > | constant_j_layer_variable_ref |
| typedef ConstantKLayerVarRef< Array3dBase< PtrArray > > | constant_k_layer_variable_ref |
| typedef IRowVarRef< Array3dBase< PtrArray > > | var_ref_i_row |
| typedef JRowVarRef< Array3dBase< PtrArray > > | var_ref_j_row |
| typedef KRowVarRef< Array3dBase< PtrArray > > | var_ref_k_row |
| Public Types inherited from EntityWithProperties | |
| typedef std::map< std::string, boost::python::object > | PythonDict |
Public Member Functions | |
| PtrArray3dBase (const size_t &n_layers=0) | |
| Default constructor. | |
| PtrArray3dBase (const size_t &n_layers, const PtrArray &) | |
| Constructor. | |
| PtrArray3dBase (const size_t &, const size_t &, const size_t &) | |
| Constructor. | |
| void | resize (const size_t &) |
| Resize the array. | |
| void | resize (const size_t &, const size_t &, const size_t &, const value_type &v=value_type()) |
| Resize the array. | |
| size_t | NumPtrs (void) const |
| Return the number of elements of the array. | |
| void | clearAll (void) |
| Clears all. | |
| void | dim (const size_t &, const size_t &, const size_t &) |
| Matrix dimensions. | |
| std::vector< int > | getLayerObjectsTags (const size_t &) |
| Return the identifiers of the objects in the layer. | |
| std::vector< int > | getRowObjectsTags (const size_t &, const size_t &) |
| Return the identifiers of the objects in the row. | |
| std::vector< int > | getRowsObjectsTags (const size_t &) |
| Return the identifiers of the objects in the f-th rows. | |
| std::vector< int > | getColumnObjectsTags (const size_t &, const size_t &) |
| Return the identifiers of the objects in the column. | |
| std::vector< int > | getColumnsObjectsTags (const size_t &) |
| Return the identifiers of the objects in the c-th columns. | |
| std::vector< int > | getLayerInteriorObjectsTags (const size_t &) |
| Return the identifiers of the objects in the layer interior. | |
| std::vector< int > | getRowInteriorObjectsTags (const size_t &, const size_t &) |
| Return the identifiers of the objects in the row interior. | |
| std::vector< int > | getRowsInteriorObjectsTags (const size_t &) |
| Return the identifiers of the objects in the c-th rows interior. | |
| std::vector< int > | getColumnInteriorObjectsTags (const size_t &, const size_t &) |
| Return the identifiers of the objects in the c-th column interior. | |
| std::vector< int > | getColumnsInteriorObjectsTags (const size_t &) |
| Return the identifiers of the objects in the c-th columns interior. | |
| std::vector< int > | getTagsInteriorObjs (void) |
| Return the tabs of the inerior elements. | |
| Public Member Functions inherited from Array3dBase< PtrArray > | |
| Array3dBase (const size_t &n_layers=0) | |
| Default constructor. | |
| Array3dBase (const size_t &n_layers, const PtrArray &) | |
| Constructor. | |
| Array3dBase (const size_t &, const size_t &, const size_t &, const value_type &def_value=value_type()) | |
| Constructor. | |
| bool | check_range (const size_t &, const size_t &, const size_t &) const |
| void | resize (const size_t &) |
| Resize the array. | |
| void | resize (const size_t &, const size_t &, const size_t &, const value_type &def_value=value_type()) |
| Resize the array. | |
| size_t | getNumberOfLayers (void) const |
| size_t | getNumberOfRows (const size_t &layer=1) const |
| size_t | getNumberOfColumns (const size_t &layer=1) const |
| size_t | getNumberOfComponents (void) const |
| Return the number of components in the container. | |
| size_t | GetDim (void) const |
| bool | isIRow (void) const |
| Returns true if only index I varies. | |
| bool | isJRow (void) const |
| Returns true if only index J varies. | |
| bool | isKRow (void) const |
| Returns true if only index K varies. | |
| bool | isIConstantLayer (void) const |
| Returns true if the indexes that vary are los J y K. | |
| bool | isJConstantLayer (void) const |
| Returns true if the indexes that vary are los I y K. | |
| bool | isKConstantLayer (void) const |
| Returns true if the indexes that vary are los I y J. | |
| size_t | NumPtrs (void) const |
| Return the number of elements of the array. | |
| bool | Null (void) const |
| Returns true if it's empty or the pointers are null. | |
| bool | HasNull (void) const |
| Returns true if it's empty or some of the pointers are null. | |
| void | clear (void) |
| Clears container. | |
| void | dim (const size_t &, const size_t &, const size_t &, const value_type &default_value=value_type()) |
| Matrix dimensions. | |
| const PtrArray & | operator() (const size_t &layer) const |
| Return the i-th layer. | |
| PtrArray & | operator() (const size_t &layer) |
| Return the i-th layer. | |
| const_reference | operator() (const size_t &i, const size_t &j, const size_t &k) const |
| reference | operator() (const size_t &i, const size_t &j, const size_t &k) |
| void | assign (const size_t &i, const size_t &j, const size_t &k, const bool &value) |
| reference | getAtI (const size_t &i) |
| const_reference | getAtI (const size_t &) const |
| reference | getAtIJ (const size_t &, const size_t &) |
| const_reference | getAtIJ (const size_t &, const size_t &) const |
| value_type | getAtIJK (const size_t &, const size_t &, const size_t &) |
| box_const_ref | getBoxConstRef (size_t layer=1, size_t f=1, size_t c=1) const |
| box_const_ref | getBoxConstRef (const Array3dRange &rango) const |
| constant_i_layer_const_ref | getConstantILayerConstRef (size_t layer=1, size_t f=1, size_t c=1) const |
| constant_i_layer_const_ref | getConstantILayerConstRef (size_t layer, const RangoIndice &, const RangoIndice &) const |
| constant_j_layer_const_ref | getConstantJLayerConstRef (size_t f=1, size_t layer=1, size_t c=1) const |
| constant_j_layer_const_ref | getConstantJLayerConstRef (const RangoIndice &, const size_t &f, const RangoIndice &) const |
| constant_k_layer_const_ref | getConstantKLayerConstRef (size_t c=1, size_t layer=1, size_t f=1) const |
| constant_k_layer_const_ref | getConstantKLayerConstRef (const RangoIndice &, const RangoIndice &, const size_t &) const |
| const_ref_i_row | getIRowConstRef (size_t f=1, size_t c=1) const |
| const_ref_i_row | getIRowConstRef (const RangoIndice &, const size_t &f, const size_t &c) const |
| const_ref_j_row | getJRowConstRef (size_t layer=1, size_t c=1) const |
| const_ref_j_row | getJRowConstRef (const size_t &layer, const RangoIndice &, const size_t &c) const |
| const_ref_k_row | getKRowConstRef (size_t layer=1, size_t f=1) const |
| const_ref_k_row | getKRowConstRef (const size_t &layer, const size_t &f, const RangoIndice &) const |
| box_var_ref | getBoxVarRef (size_t layer=1, size_t f=1, size_t c=1) |
| box_var_ref | getBoxVarRef (const Array3dRange &) |
| constant_i_layer_variable_ref | getConstantILayerVarRef (size_t layer=1, size_t f=1, size_t c=1) |
| constant_i_layer_variable_ref | getConstantILayerVarRef (const size_t &layer, const RangoIndice &, const RangoIndice &) |
| constant_j_layer_variable_ref | getConstantJLayerVarRef (size_t f=1, size_t layer=1, size_t c=1) |
| constant_j_layer_variable_ref | getConstantJLayerVarRef (const RangoIndice &, const size_t &f, const RangoIndice &) |
| constant_k_layer_variable_ref | getConstantKLayerVarRef (size_t c=1, size_t layer=1, size_t f=1) |
| constant_k_layer_variable_ref | getConstantKLayerVarRef (const RangoIndice &, const RangoIndice &, const size_t &c) |
| var_ref_i_row | getVarRefIRow (size_t f=1, size_t c=1) |
| var_ref_i_row | getVarRefIRow (const RangoIndice &, const size_t &f, const size_t &c) |
| var_ref_j_row | getVarRefJRow (size_t layer=1, size_t c=1) |
| var_ref_j_row | getVarRefJRow (const size_t &layer, const RangoIndice &, const size_t &c) |
| var_ref_k_row | getVarRefKRow (size_t layer=1, size_t f=1) |
| var_ref_k_row | getVarRefKRow (const size_t &layer, const size_t &f, const RangoIndice &) |
| void | putBox (size_t layer_offset, size_t row_offset, size_t offset_col, const Array3dBase< PtrArray > &) |
| Put in the array the array argument. | |
| Public Member Functions inherited from CommandEntity | |
| CommandEntity (CommandEntity *owr=nullptr) | |
| Default constructor. | |
| CommandEntity * | Owner (void) |
| Return a pointer to the object owner. | |
| const CommandEntity * | Owner (void) const |
| Return un puntero al objeto propietario de ESTE. | |
| const StandardOutputWrapper & | getStandardOutputWrapper (void) const |
| Return the regular output stream wrapper. | |
| StandardOutputWrapper & | getStandardOutputWrapper (void) |
| Return the regular output stream wrapper. | |
| const std::string & | getLogFileName (void) const |
| Returns log file name. | |
| void | setLogFileName (const std::string &) |
| Sets log file name. | |
| const std::string & | getErrFileName (void) const |
| Returns err file name. | |
| void | setErrFileName (const std::string &) |
| Sets error file name. | |
| const std::string & | getOutputFileName (void) const |
| Returns regular output file name. | |
| void | setOutputFileName (const std::string &) |
| Sets regular output file name. | |
| boost::python::object | evalPy (boost::python::object dict, const std::string &) |
| Return the Python object that results from evaluating the argument. | |
| boost::python::object | execPy (boost::python::object dict, const std::string &) |
| Return the Python objects that results from executing the code in the string argument. | |
| boost::python::object | execFilePy (boost::python::object dict, const std::string &) |
| Return the Python object that results from executing the code in the file. | |
| Public Member Functions inherited from EntityWithProperties | |
| EntityWithProperties (EntityWithProperties *owr=nullptr) | |
| Default constructor. | |
| void | clearPyProps (void) |
| Clear python properties map. | |
| bool | hasPyProp (const std::string &) |
| Returns true if property exists. | |
| boost::python::object | getPyProp (const std::string &str) |
| Return the Python object with the name being passed as parameter. | |
| void | setPyProp (std::string str, boost::python::object val) |
| Sets/appends a value tho the Python object's dictionary. | |
| void | copyPropsFrom (const EntityWithProperties &) |
| Copy the properties from the argument. | |
| boost::python::list | getPropNames (void) const |
| Return the names of the object properties weightings. | |
| const PythonDict & | getPropertiesDict (void) const |
| Return a std::map container with the properties of the object. | |
| boost::python::dict | getPyDict (void) const |
| Return a Python dictionary containing the object members values. | |
| void | setPyDict (const boost::python::dict &) |
| Set the values of the object members from a Python dictionary. | |
| Public Member Functions inherited from EntityWithOwner | |
| EntityWithOwner (EntityWithOwner *owr=nullptr) | |
| Default constructor. | |
| EntityWithOwner (const EntityWithOwner &) | |
| Copy constructor. | |
| EntityWithOwner & | operator= (const EntityWithOwner &) |
| Assignment operator. | |
| virtual bool | operator== (const EntityWithOwner &) const |
| Comparison operator. | |
| virtual | ~EntityWithOwner (void) |
| Virtual destructor. | |
| virtual std::string | getClassName (void) const |
| Returns demangled class name. | |
| void | set_owner (EntityWithOwner *owr) |
| Assigns the owner of the object. | |
| EntityWithOwner * | Owner (void) |
| const EntityWithOwner * | Owner (void) const |
Protected Member Functions | |
| void | set_owner_matrices (void) |
| Sets the owner for the matrices. | |
| Protected Member Functions inherited from Array3dBase< PtrArray > | |
| matrix_type & | get_layer (const size_t &iLayer) |
| const matrix_type & | get_layer (const size_t &iLayer) const |
| Protected Member Functions inherited from CommandEntity | |
| template<class T > | |
| void | string_to (T &, const std::string &) const |
| Protected Member Functions inherited from EntityWithProperties | |
| bool | isEqual (const EntityWithProperties &) const |
| Return true if both objects are equal. | |
| Protected Member Functions inherited from EntityWithOwner | |
| virtual bool | isEqual (const EntityWithOwner &) const |
| Return true if both objects are equal. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from CommandEntity | |
| static void | resetStandardOutput (void) |
| Reset the standard output streams to its defaults buffers. | |
| Static Public Member Functions inherited from EntityWithOwner | |
| static int | getVerbosityLevel (void) |
| Get the value of the verbosity level. | |
| static void | setVerbosityLevel (const int &) |
| Set the value of the verbosity level. | |
| Static Protected Member Functions inherited from CommandEntity | |
| static CommandEntity * | entcmd_cast (boost::any &data) |
| Static Protected Attributes inherited from EntityWithOwner | |
| static int | verbosity = 1 |
| Object that owns THIS ONE. More... | |
Detailed Description
template<class PtrArray>
class XC::PtrArray3dBase< PtrArray >
Three-dimensional array of object pointers.
The documentation for this class was generated from the following file:
- src/preprocessor/multi_block_topology/matrices/PtrArray3dBase.h
