GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
cdef_method Class Reference

#include "cdef-method.h"

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

Classes

class  cdef_method_rep
 

Public Member Functions

 cdef_method (const cdef_method &meth)
 
 cdef_method (const cdef_object &obj)
 
 cdef_method (const std::string &nm)
 
 cdef_method (void)
 
 ~cdef_method (void)=default
 
Array< cdef_object > array_value (void) const
 
void break_closure_cycles (const std::shared_ptr< stack_frame > &frame)
 
bool check_access (void) const
 
std::string class_name (void) const
 
cdef_object clone (void) const
 
cdef_object copy (void) const
 
dim_vector dims (void) const
 
cdef_object empty_clone (void) const
 
octave_value_list execute (const cdef_object &obj, const octave_value_list &args, int nargout, bool do_check_access=true, const std::string &who="")
 
octave_value_list execute (const octave_value_list &args, int nargout, bool do_check_access=true, const std::string &who="")
 
octave_value get (const std::string &pname) const
 
OCTINTERP_API cdef_class get_class (void) const
 
std::string get_doc_string (void)
 
octave_value get_function (void) const
 
std::string get_name (void) const
 
octave_value get_property (octave_idx_type idx, const std::string &pname) const
 
bool is (const cdef_object &obj) const
 
bool is_array (void) const
 
bool is_class (void) const
 
bool is_constructed (void) const
 
bool is_constructed_for (const cdef_class &cls) const
 
bool is_constructor (void) const
 
bool is_defined_in_class (const std::string &cname) const
 
bool is_external (void) const
 
bool is_handle_object (void) const
 
bool is_meta_object (void) const
 
bool is_method (void) const
 
bool is_package (void) const
 
bool is_partially_constructed_for (const cdef_class &cls) const
 
bool is_property (void) const
 
bool is_static (void) const
 
bool is_value_object (void) const
 
cdef_object make_array (void) const
 
string_vector map_keys (void) const
 
OCTINTERP_API octave_map map_value (void) const
 
void mark_as_constructed (const cdef_class &cls)
 
void mark_as_constructed (void)
 
void mark_as_external (const std::string &dtype)
 
void mark_for_construction (const cdef_class &cls)
 
bool meta_accepts_postfix_index (char type) const
 
void meta_release (void)
 
octave_value_list meta_subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout)
 
bool ok (void) const
 
cdef_method & operator= (const cdef_method &meth)
 
void put (const std::string &pname, const octave_value &val)
 
void set_class (const cdef_class &cls)
 
void set_function (const octave_value &fcn)
 
void set_property (octave_idx_type idx, const std::string &pname, const octave_value &pval)
 
octave_value subsasgn (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs, int ignore_copies=0)
 
octave_value_list subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout, std::size_t &skip, const cdef_class &context, bool auto_add=false)
 

Protected Member Functions

void make_unique (int ignore_copies)
 

Private Member Functions

cdef_method_rep * get_rep (void)
 
const cdef_method_rep * get_rep (void) const
 

Private Attributes

cdef_object_rep * m_rep
 

Friends

class cdef_class
 

Detailed Description

Definition at line 42 of file cdef-method.h.

Constructor & Destructor Documentation

◆ cdef_method() [1/4]

cdef_method::cdef_method ( void  )
inline

Definition at line 135 of file cdef-method.h.

◆ cdef_method() [2/4]

cdef_method::cdef_method ( const std::string &  nm)
inline

Definition at line 137 of file cdef-method.h.

References cdef_class::get_rep(), and cdef_class::cdef_class_rep::set_name().

◆ cdef_method() [3/4]

cdef_method::cdef_method ( const cdef_method &  meth)
inline

Definition at line 143 of file cdef-method.h.

◆ cdef_method() [4/4]

cdef_method::cdef_method ( const cdef_object &  obj)
inline

Definition at line 145 of file cdef-method.h.

References cdef_object::class_name(), error(), and cdef_meta_object::is_method().

◆ ~cdef_method()

cdef_method::~cdef_method ( void  )
default

Member Function Documentation

◆ array_value()

Array<cdef_object> cdef_object::array_value ( void  ) const
inlineinherited

Definition at line 260 of file cdef-object.h.

References cdef_object_rep::array_value(), and cdef_object::m_rep.

Referenced by cdef_object::map_value(), and cdef_object_array::subsasgn().

◆ break_closure_cycles()

void cdef_object::break_closure_cycles ( const std::shared_ptr< stack_frame > &  frame)
inlineinherited

Definition at line 285 of file cdef-object.h.

References cdef_object_rep::break_closure_cycles(), and cdef_object::m_rep.

◆ check_access()

bool cdef_method::check_access ( void  ) const
inline

Definition at line 180 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by cdef_method::cdef_method_rep::execute().

◆ class_name()

std::string cdef_object::class_name ( void  ) const
inlineinherited

Definition at line 234 of file cdef-object.h.

References cdef_object_rep::class_name(), and cdef_object::m_rep.

Referenced by cdef_method(), cdef_package::cdef_package(), cdef_property::cdef_property(), cdef_class::make_meta_class(), cdef_object_array::subsasgn(), and ctor_analyzer::visit_superclass_ref().

◆ clone()

cdef_object cdef_object::clone ( void  ) const
inlineinherited

Definition at line 236 of file cdef-object.h.

References cdef_object, cdef_object_rep::clone(), and cdef_object::m_rep.

Referenced by value_cdef_object::copy(), and cdef_object::make_unique().

◆ copy()

cdef_object cdef_object::copy ( void  ) const
inlineinherited

Definition at line 250 of file cdef-object.h.

References cdef_object, cdef_object_rep::copy(), and cdef_object::m_rep.

Referenced by cdef_object_array::fill_empty_values().

◆ dims()

dim_vector cdef_object::dims ( void  ) const
inlineinherited

Definition at line 243 of file cdef-object.h.

References cdef_object_rep::dims(), and cdef_object::m_rep.

◆ empty_clone()

cdef_object cdef_object::empty_clone ( void  ) const
inlineinherited

Definition at line 238 of file cdef-object.h.

References cdef_object, cdef_object_rep::empty_clone(), and cdef_object::m_rep.

◆ execute() [1/2]

octave_value_list cdef_method::execute ( const cdef_object &  obj,
const octave_value_list &  args,
int  nargout,
bool  do_check_access = true,
const std::string &  who = "" 
)
inline

Definition at line 172 of file cdef-method.h.

References cdef_class::get_rep().

◆ execute() [2/2]

octave_value_list cdef_method::execute ( const octave_value_list &  args,
int  nargout,
bool  do_check_access = true,
const std::string &  who = "" 
)
inline

Definition at line 164 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by class_fevalStatic(), cdef_class::cdef_class_rep::delete_object(), cdef_class::cdef_class_rep::meta_subsref(), cdef_method::cdef_method_rep::meta_subsref(), cdef_class::cdef_class_rep::run_constructor(), and cdef_object_scalar::subsref().

◆ get()

octave_value cdef_object::get ( const std::string &  pname) const
inlineinherited

Definition at line 268 of file cdef-object.h.

References cdef_object_rep::get(), and cdef_object::m_rep.

Referenced by check_access(), cdef_method::cdef_method_rep::check_access(), cdef_property::cdef_property_rep::check_get_access(), cdef_property::cdef_property_rep::check_set_access(), class_get_inferiorclasses(), class_get_superclasses(), cdef_class::cdef_class_rep::delete_object(), err_method_access(), cdef_property::cdef_property_rep::err_property_access(), cdef_method::cdef_method_rep::execute(), cdef_class::cdef_class_rep::find_method(), cdef_class::cdef_class_rep::find_methods(), cdef_class::cdef_class_rep::find_names(), cdef_class::cdef_class_rep::find_properties(), cdef_class::cdef_class_rep::find_property(), Fproperties(), cdef_method::cdef_method_rep::get_name(), cdef_package::cdef_package_rep::get_name(), cdef_property::cdef_property_rep::get_name(), cdef_object_array::get_property(), cdef_object_scalar::get_property(), cdef_property::cdef_property_rep::get_value(), cdef_class::cdef_class_rep::initialize_object(), cdef_property::cdef_property_rep::is_constant(), cdef_method::cdef_method_rep::is_static(), is_superclass(), cdef_class::make_meta_class(), cdef_object_scalar::mark_for_construction(), property_get_defaultvalue(), and cdef_property::cdef_property_rep::set_value().

◆ get_class()

cdef_class cdef_object::get_class ( void  ) const
inherited

Definition at line 183 of file cdef-object.cc.

References cdef_object_rep::get_class(), and cdef_object::m_rep.

Referenced by Fmetaclass(), tree_evaluator::make_fcn_handle(), cdef_object::map_value(), and cdef_object_array::subsasgn().

◆ get_doc_string()

std::string cdef_method::get_doc_string ( void  )
inline

Definition at line 196 of file cdef-method.h.

References cdef_class::get_rep().

◆ get_function()

octave_value cdef_method::get_function ( void  ) const
inline

Definition at line 191 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by cdef_class::cdef_class_rep::install_method(), and tree_evaluator::make_fcn_handle().

◆ get_name()

std::string cdef_method::get_name ( void  ) const
inline

Definition at line 182 of file cdef-method.h.

References cdef_class::cdef_class_rep::get_name(), and cdef_class::get_rep().

Referenced by cdef_method::cdef_method_rep::check_access(), err_method_access(), and cdef_class::cdef_class_rep::install_method().

◆ get_property()

octave_value cdef_object::get_property ( octave_idx_type  idx,
const std::string &  pname 
) const
inlineinherited

Definition at line 280 of file cdef-object.h.

References cdef_object_rep::get_property(), and cdef_object::m_rep.

◆ get_rep() [1/2]

cdef_method_rep* cdef_method::get_rep ( void  )
inlineprivate

Definition at line 220 of file cdef-method.h.

References cdef_object::get_rep().

◆ get_rep() [2/2]

const cdef_method_rep* cdef_method::get_rep ( void  ) const
inlineprivate

Definition at line 225 of file cdef-method.h.

References cdef_object::get_rep().

◆ is()

bool cdef_object::is ( const cdef_object &  obj) const
inlineinherited

Definition at line 336 of file cdef-object.h.

References cdef_object::m_rep.

Referenced by is_method_executing(), and cdef_object_array::subsasgn().

◆ is_array()

bool cdef_object::is_array ( void  ) const
inlineinherited

Definition at line 252 of file cdef-object.h.

References cdef_object_rep::is_array(), and cdef_object::m_rep.

Referenced by cdef_object::map_value(), and cdef_object_array::subsasgn().

◆ is_class()

bool cdef_meta_object::is_class ( void  ) const
inlineinherited

Definition at line 680 of file cdef-object.h.

References cdef_object::get_rep().

◆ is_constructed()

bool cdef_object::is_constructed ( void  ) const
inlineinherited

Definition at line 319 of file cdef-object.h.

References cdef_object_rep::is_constructed(), and cdef_object::m_rep.

Referenced by cdef_property::cdef_property_rep::get_value(), and cdef_property::cdef_property_rep::set_value().

◆ is_constructed_for()

bool cdef_object::is_constructed_for ( const cdef_class &  cls) const
inlineinherited

Definition at line 321 of file cdef-object.h.

References cdef_object_rep::is_constructed_for(), and cdef_object::m_rep.

◆ is_constructor()

bool cdef_method::is_constructor ( void  ) const
inline

Definition at line 201 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by cdef_class::cdef_class_rep::install_method().

◆ is_defined_in_class()

bool cdef_method::is_defined_in_class ( const std::string &  cname) const
inline

Definition at line 206 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by cdef_class::cdef_class_rep::delete_object().

◆ is_external()

bool cdef_method::is_external ( void  ) const
inline

Definition at line 211 of file cdef-method.h.

References cdef_class::get_rep().

◆ is_handle_object()

bool cdef_object::is_handle_object ( void  ) const
inlineinherited

Definition at line 256 of file cdef-object.h.

References cdef_object_rep::is_handle_object(), and cdef_object::m_rep.

Referenced by cdef_property::cdef_property_rep::set_value().

◆ is_meta_object()

bool cdef_object::is_meta_object ( void  ) const
inlineinherited

Definition at line 258 of file cdef-object.h.

References cdef_object_rep::is_meta_object(), and cdef_object::m_rep.

◆ is_method()

bool cdef_meta_object::is_method ( void  ) const
inlineinherited

Definition at line 684 of file cdef-object.h.

References cdef_object::get_rep().

Referenced by cdef_method().

◆ is_package()

bool cdef_meta_object::is_package ( void  ) const
inlineinherited

Definition at line 686 of file cdef-object.h.

References cdef_object::get_rep().

Referenced by cdef_package::cdef_package().

◆ is_partially_constructed_for()

bool cdef_object::is_partially_constructed_for ( const cdef_class &  cls) const
inlineinherited

Definition at line 326 of file cdef-object.h.

References cdef_object_rep::is_partially_constructed_for(), and cdef_object::m_rep.

Referenced by cdef_property::cdef_property_rep::get_value(), and cdef_property::cdef_property_rep::set_value().

◆ is_property()

bool cdef_meta_object::is_property ( void  ) const
inlineinherited

Definition at line 682 of file cdef-object.h.

References cdef_object::get_rep().

Referenced by cdef_property::cdef_property().

◆ is_static()

bool cdef_method::is_static ( void  ) const
inline

Definition at line 184 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by class_fevalStatic(), tree_evaluator::make_fcn_handle(), cdef_class::cdef_class_rep::meta_subsref(), and cdef_object_scalar::subsref().

◆ is_value_object()

bool cdef_object::is_value_object ( void  ) const
inlineinherited

Definition at line 254 of file cdef-object.h.

References cdef_object_rep::is_value_object(), and cdef_object::m_rep.

◆ make_array()

cdef_object cdef_object::make_array ( void  ) const
inlineinherited

Definition at line 245 of file cdef-object.h.

References cdef_object, cdef_object::m_rep, and cdef_object_rep::make_array().

◆ make_unique()

void cdef_object::make_unique ( int  ignore_copies)
inlineprotectedinherited

Definition at line 342 of file cdef-object.h.

References cdef_object::clone(), cdef_object_rep::m_count, and cdef_object::m_rep.

Referenced by cdef_object::subsasgn().

◆ map_keys()

string_vector cdef_object::map_keys ( void  ) const
inlineinherited

Definition at line 306 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::map_keys().

◆ map_value()

octave_map cdef_object::map_value ( void  ) const
inherited

Definition at line 137 of file cdef-object.cc.

References cdef_object::array_value(), Array< T, Alloc >::dims(), cdef_object::get_class(), cdef_class::get_property_map(), cdef_object::is_array(), Array< T, Alloc >::numel(), cdef_object::ok(), cdef_class::property_all, octave_map::setfield(), and warning_with_id().

◆ mark_as_constructed() [1/2]

void cdef_object::mark_as_constructed ( const cdef_class &  cls)
inlineinherited

Definition at line 333 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::mark_as_constructed().

◆ mark_as_constructed() [2/2]

void cdef_object::mark_as_constructed ( void  )
inlineinherited

Definition at line 331 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::mark_as_constructed().

Referenced by cdef_class::cdef_class_rep::run_constructor().

◆ mark_as_external()

void cdef_method::mark_as_external ( const std::string &  dtype)
inline

Definition at line 213 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by cdef_manager::make_method().

◆ mark_for_construction()

void cdef_object::mark_for_construction ( const cdef_class &  cls)
inlineinherited

Definition at line 314 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::mark_for_construction().

Referenced by cdef_class::cdef_class_rep::initialize_object().

◆ meta_accepts_postfix_index()

bool cdef_meta_object::meta_accepts_postfix_index ( char  type) const
inlineinherited

Definition at line 697 of file cdef-object.h.

References cdef_object::get_rep().

◆ meta_release()

void cdef_meta_object::meta_release ( void  )
inlineinherited

Definition at line 695 of file cdef-object.h.

References cdef_object::get_rep().

◆ meta_subsref()

octave_value_list cdef_meta_object::meta_subsref ( const std::string &  type,
const std::list< octave_value_list > &  idx,
int  nargout 
)
inlineinherited

Definition at line 689 of file cdef-object.h.

References cdef_object::get_rep().

◆ ok()

bool cdef_object::ok ( void  ) const
inlineinherited

Definition at line 312 of file cdef-object.h.

References cdef_object_rep::is_valid(), and cdef_object::m_rep.

Referenced by check_access(), class_fevalStatic(), class_getConstant(), cdef_class::cdef_class_rep::construct(), cdef_class::cdef_class_rep::construct_object(), cdef_class::cdef_class_rep::delete_object(), F__methods__(), cdef_object_array::fill_empty_values(), cdef_manager::find_class(), cdef_class::cdef_class_rep::find_method(), cdef_manager::find_method_symbol(), cdef_manager::find_package(), cdef_manager::find_package_symbol(), cdef_class::cdef_class_rep::find_property(), Fproperties(), tree_evaluator::make_fcn_handle(), tree_classdef::make_meta_class(), cdef_class::make_meta_class(), cdef_object_rep::map_keys(), cdef_object::map_value(), cdef_class::cdef_class_rep::meta_subsref(), cdef_class::cdef_class_rep::run_constructor(), cdef_object_base::set_class(), cdef_object_array::subsasgn(), cdef_object_scalar::subsasgn(), cdef_object_scalar::subsref(), to_ov(), and ctor_analyzer::visit_superclass_ref().

◆ operator=()

cdef_method& cdef_method::operator= ( const cdef_method &  meth)
inline

Definition at line 154 of file cdef-method.h.

References cdef_object::operator=().

◆ put()

void cdef_object::put ( const std::string &  pname,
const octave_value &  val 
)
inlineinherited

Definition at line 263 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::put().

Referenced by cdef_class::cdef_class_rep::initialize_object(), cdef_manager::make_class(), cdef_manager::make_meta_class(), cdef_class::make_meta_class(), cdef_manager::make_method(), cdef_manager::make_package(), cdef_manager::make_property(), cdef_method::cdef_method_rep::set_name(), cdef_package::cdef_package_rep::set_name(), cdef_property::cdef_property_rep::set_name(), cdef_object_array::set_property(), cdef_object_scalar::set_property(), and cdef_property::cdef_property_rep::set_value().

◆ set_class()

void cdef_object::set_class ( const cdef_class &  cls)
inlineinherited

Definition at line 232 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::set_class().

Referenced by cdef_manager::cdef_manager(), cdef_class::cdef_class_rep::construct_object(), cdef_manager::make_class(), cdef_manager::make_method(), cdef_manager::make_package(), cdef_manager::make_property(), cdef_object_scalar::subsasgn(), cdef_object_array::subsref(), and cdef_object_scalar::subsref().

◆ set_function()

void cdef_method::set_function ( const octave_value &  fcn)
inline

Definition at line 186 of file cdef-method.h.

References cdef_class::get_rep().

Referenced by cdef_manager::make_method().

◆ set_property()

void cdef_object::set_property ( octave_idx_type  idx,
const std::string &  pname,
const octave_value &  pval 
)
inlineinherited

Definition at line 273 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::set_property().

◆ subsasgn()

octave_value cdef_object::subsasgn ( const std::string &  type,
const std::list< octave_value_list > &  idx,
const octave_value &  rhs,
int  ignore_copies = 0 
)
inlineinherited

Definition at line 299 of file cdef-object.h.

References cdef_object::m_rep, cdef_object::make_unique(), and cdef_object_rep::subsasgn().

Referenced by cdef_object_array::subsasgn(), and cdef_object_scalar::subsasgn().

◆ subsref()

octave_value_list cdef_object::subsref ( const std::string &  type,
const std::list< octave_value_list > &  idx,
int  nargout,
std::size_t &  skip,
const cdef_class &  context,
bool  auto_add = false 
)
inlineinherited

Definition at line 291 of file cdef-object.h.

References cdef_object::m_rep, and cdef_object_rep::subsref().

Referenced by cdef_object_scalar::subsref().

Friends And Related Function Documentation

◆ cdef_class

friend class cdef_class
friend

Definition at line 46 of file cdef-method.h.

Member Data Documentation

◆ m_rep

cdef_object_rep* cdef_object::m_rep
privateinherited

Definition at line 350 of file cdef-object.h.

Referenced by cdef_object::cdef_object(), cdef_object::~cdef_object(), cdef_object::array_value(), cdef_object::break_closure_cycles(), cdef_object::class_name(), cdef_object::clone(), cdef_object::copy(), cdef_object::dims(), cdef_object::empty_clone(), cdef_object::get(), cdef_object::get_class(), cdef_object::get_property(), cdef_object::get_rep(), cdef_object::is(), cdef_object::is_array(), cdef_object::is_constructed(), cdef_object::is_constructed_for(), cdef_object::is_handle_object(), cdef_object::is_meta_object(), cdef_object::is_partially_constructed_for(), cdef_object::is_value_object(), cdef_object::make_array(), cdef_object::make_unique(), cdef_object::map_keys(), cdef_object::mark_as_constructed(), cdef_object::mark_for_construction(), cdef_object::ok(), cdef_object::operator=(), cdef_object::put(), cdef_object::set_class(), cdef_object::set_property(), cdef_object::subsasgn(), and cdef_object::subsref().

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