GNU Octave  6.2.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
octave::cdef_method Class Reference

#include "cdef-method.h"

Inheritance diagram for octave::cdef_method:
Inheritance graph
[legend]
Collaboration diagram for octave::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
 
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
 
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
 
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, 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 * rep
 

Friends

class cdef_class
 

Detailed Description

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

Constructor & Destructor Documentation

◆ cdef_method() [1/4]

octave::cdef_method::cdef_method ( void  )
inline

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

◆ cdef_method() [2/4]

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

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

◆ cdef_method() [3/4]

octave::cdef_method::cdef_method ( const cdef_method &  meth)
inline

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

◆ cdef_method() [4/4]

octave::cdef_method::cdef_method ( const cdef_object &  obj)
inline

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

References error().

◆ ~cdef_method()

octave::cdef_method::~cdef_method ( void  )
default

Member Function Documentation

◆ array_value()

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

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

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

◆ check_access()

bool octave::cdef_method::check_access ( void  ) const
inline

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

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

◆ class_name()

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

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

Referenced by octave::cdef_class::make_meta_class(), octave::cdef_object_array::subsasgn(), and octave::ctor_analyzer::visit_superclass_ref().

◆ clone()

cdef_object octave::cdef_object::clone ( void  ) const
inlineinherited

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

◆ copy()

cdef_object octave::cdef_object::copy ( void  ) const
inlineinherited

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

Referenced by octave::cdef_object_array::fill_empty_values().

◆ dims()

dim_vector octave::cdef_object::dims ( void  ) const
inlineinherited

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

◆ empty_clone()

cdef_object octave::cdef_object::empty_clone ( void  ) const
inlineinherited

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

◆ execute() [1/2]

octave_value_list octave::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 171 of file cdef-method.h.

◆ execute() [2/2]

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

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

Referenced by octave::class_fevalStatic(), octave::cdef_class::cdef_class_rep::delete_object(), octave_classdef_superclass_ref::execute(), octave::cdef_class::cdef_class_rep::meta_subsref(), octave::cdef_method::cdef_method_rep::meta_subsref(), octave::cdef_class::cdef_class_rep::run_constructor(), octave_classdef::size(), octave_classdef::subsasgn(), octave_classdef::subsref(), octave::cdef_object_scalar::subsref(), and octave_classdef::xnumel().

◆ get()

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

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

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

◆ get_class()

cdef_class octave::cdef_object::get_class ( void  ) const
inherited

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

References octave::cdef_object_rep::get_class(), and octave::cdef_object::rep.

Referenced by Fmetaclass(), octave::tree_evaluator::make_fcn_handle(), octave::cdef_object::map_value(), octave_classdef::print_raw(), octave_classdef::size(), octave::cdef_object_array::subsasgn(), octave_classdef::subsasgn(), octave_classdef::subsref(), and octave_classdef::xnumel().

◆ get_doc_string()

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

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

Referenced by octave_classdef_meta::doc_string().

◆ get_function()

octave_value octave::cdef_method::get_function ( void  ) const
inline

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

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

◆ get_name()

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

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

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

◆ get_property()

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

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

◆ get_rep() [1/2]

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

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

References octave::cdef_object::get_rep().

◆ get_rep() [2/2]

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

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

References octave::cdef_object::get_rep().

◆ is()

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

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

References octave::cdef_object::rep.

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

◆ is_array()

bool octave::cdef_object::is_array ( void  ) const
inlineinherited

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

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

◆ is_class()

bool octave::cdef_meta_object::is_class ( void  ) const
inlineinherited

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

◆ is_constructed()

bool octave::cdef_object::is_constructed ( void  ) const
inlineinherited

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

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

◆ is_constructed_for()

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

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

◆ is_constructor()

bool octave::cdef_method::is_constructor ( void  ) const
inline

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

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

◆ is_defined_in_class()

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

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

Referenced by octave::cdef_class::cdef_class_rep::delete_object(), and octave_classdef_meta::is_classdef_method().

◆ is_external()

bool octave::cdef_method::is_external ( void  ) const
inline

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

◆ is_handle_object()

bool octave::cdef_object::is_handle_object ( void  ) const
inlineinherited

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

◆ is_meta_object()

bool octave::cdef_object::is_meta_object ( void  ) const
inlineinherited

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

◆ is_method()

bool octave::cdef_meta_object::is_method ( void  ) const
inlineinherited

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

◆ is_package()

bool octave::cdef_meta_object::is_package ( void  ) const
inlineinherited

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

◆ is_partially_constructed_for()

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

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

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

◆ is_property()

bool octave::cdef_meta_object::is_property ( void  ) const
inlineinherited

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

◆ is_static()

bool octave::cdef_method::is_static ( void  ) const
inline

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

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

◆ is_value_object()

bool octave::cdef_object::is_value_object ( void  ) const
inlineinherited

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

◆ make_array()

cdef_object octave::cdef_object::make_array ( void  ) const
inlineinherited

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

◆ make_unique()

void octave::cdef_object::make_unique ( int  ignore_copies)
inlineprotectedinherited

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

◆ map_keys()

string_vector octave::cdef_object::map_keys ( void  ) const
inlineinherited

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

◆ map_value()

octave_map octave::cdef_object::map_value ( void  ) const
inherited

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

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

◆ mark_as_constructed() [1/2]

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

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

◆ mark_as_constructed() [2/2]

void octave::cdef_object::mark_as_constructed ( void  )
inlineinherited

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

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

◆ mark_as_external()

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

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

Referenced by octave::cdef_manager::make_method().

◆ mark_for_construction()

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

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

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

◆ meta_accepts_postfix_index()

bool octave::cdef_meta_object::meta_accepts_postfix_index ( char  type) const
inlineinherited

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

◆ meta_release()

void octave::cdef_meta_object::meta_release ( void  )
inlineinherited

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

◆ meta_subsref()

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

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

◆ ok()

bool octave::cdef_object::ok ( void  ) const
inlineinherited

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

Referenced by octave::check_access(), octave::class_fevalStatic(), octave::class_getConstant(), octave::cdef_class::cdef_class_rep::construct(), octave::cdef_class::cdef_class_rep::construct_object(), octave::cdef_class::cdef_class_rep::delete_object(), octave_classdef_meta::doc_string(), octave_classdef_superclass_ref::execute(), F__methods__(), octave::cdef_object_array::fill_empty_values(), octave::cdef_manager::find_class(), octave::cdef_class::cdef_class_rep::find_method(), octave::cdef_manager::find_method_symbol(), octave::cdef_manager::find_package_symbol(), octave::cdef_class::cdef_class_rep::find_property(), Fproperties(), in_class_method(), octave_classdef::is_instance_of(), octave::tree_evaluator::make_fcn_handle(), octave::tree_classdef::make_meta_class(), octave::cdef_class::make_meta_class(), octave::cdef_object_rep::map_keys(), octave::cdef_object::map_value(), octave::cdef_class::cdef_class_rep::meta_subsref(), octave_classdef::print_raw(), read_mat5_binary_element(), octave::cdef_class::cdef_class_rep::run_constructor(), octave::cdef_object_base::set_class(), octave_classdef::size(), octave::cdef_object_array::subsasgn(), octave::cdef_object_scalar::subsasgn(), octave_classdef::subsasgn(), octave_classdef::subsref(), octave::cdef_object_scalar::subsref(), octave::to_ov(), octave::ctor_analyzer::visit_superclass_ref(), and octave_classdef::xnumel().

◆ operator=()

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

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

References octave::cdef_object::operator=().

◆ put()

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

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

Referenced by octave::cdef_class::cdef_class_rep::initialize_object(), octave::cdef_manager::make_class(), octave::cdef_manager::make_meta_class(), octave::cdef_class::make_meta_class(), octave::cdef_manager::make_method(), octave::cdef_manager::make_package(), octave::cdef_manager::make_property(), octave::cdef_object_array::set_property(), and octave::cdef_property::cdef_property_rep::set_value().

◆ set_class()

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

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

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

◆ set_function()

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

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

Referenced by octave::cdef_manager::make_method().

◆ set_property()

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

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

◆ subsasgn()

octave_value octave::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 287 of file cdef-object.h.

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

◆ subsref()

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

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

References octave::context.

Referenced by octave::cdef_object_scalar::subsref().

Friends And Related Function Documentation

◆ cdef_class

friend class cdef_class
friend

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

Member Data Documentation

◆ rep

cdef_object_rep* octave::cdef_object::rep
privateinherited

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

Referenced by octave::cdef_object::get_class(), octave::cdef_object::is(), and octave::cdef_object::operator=().

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