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

#include "cdef-property.h"

Inheritance diagram for octave::cdef_property:
Inheritance graph
[legend]
Collaboration diagram for octave::cdef_property:
Collaboration graph
[legend]

Classes

class  cdef_property_rep
 

Public Member Functions

 cdef_property (const cdef_object &obj)
 
 cdef_property (const cdef_property &prop)
 
 cdef_property (const std::string &nm)
 
 cdef_property (void)
 
 ~cdef_property (void)=default
 
Array< cdef_object > array_value (void) const
 
void break_closure_cycles (const std::shared_ptr< stack_frame > &frame)
 
bool check_get_access (void) const
 
bool check_set_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 get (const std::string &pname) const
 
OCTINTERP_API cdef_class get_class (void) const
 
std::string get_name (void) const
 
octave_value get_property (octave_idx_type idx, const std::string &pname) const
 
octave_value get_value (bool do_check_access=true, const std::string &who="") const
 
octave_value get_value (const cdef_object &obj, bool do_check_access=true, const std::string &who="") const
 
bool is (const cdef_object &obj) const
 
bool is_array (void) const
 
bool is_class (void) const
 
bool is_constant (void) const
 
bool is_constructed (void) const
 
bool is_constructed_for (const cdef_class &cls) 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_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_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_property & operator= (const cdef_property &prop)
 
void put (const std::string &pname, const octave_value &val)
 
void set_class (const cdef_class &cls)
 
void set_property (octave_idx_type idx, const std::string &pname, const octave_value &pval)
 
void set_value (cdef_object &obj, const octave_value &val, bool do_check_access=true, const std::string &who="")
 
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_property_rep * get_rep (void)
 
const cdef_property_rep * get_rep (void) const
 

Private Attributes

cdef_object_rep * m_rep
 

Friends

class cdef_class
 

Detailed Description

Definition at line 43 of file cdef-property.h.

Constructor & Destructor Documentation

◆ cdef_property() [1/4]

octave::cdef_property::cdef_property ( void  )
inline

Definition at line 110 of file cdef-property.h.

◆ cdef_property() [2/4]

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

Definition at line 112 of file cdef-property.h.

◆ cdef_property() [3/4]

octave::cdef_property::cdef_property ( const cdef_property &  prop)
inline

Definition at line 118 of file cdef-property.h.

◆ cdef_property() [4/4]

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

Definition at line 120 of file cdef-property.h.

References error().

◆ ~cdef_property()

octave::cdef_property::~cdef_property ( void  )
default

Member Function Documentation

◆ array_value()

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

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

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

◆ break_closure_cycles()

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

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

◆ check_get_access()

bool octave::cdef_property::check_get_access ( void  ) const
inline

Definition at line 157 of file cdef-property.h.

Referenced by octave::cdef_property::cdef_property_rep::get_value().

◆ check_set_access()

bool octave::cdef_property::check_set_access ( void  ) const
inline

Definition at line 162 of file cdef-property.h.

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

◆ class_name()

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

Definition at line 233 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 235 of file cdef-object.h.

References octave::cdef_object.

◆ copy()

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

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

References octave::cdef_object.

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

◆ dims()

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

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

◆ empty_clone()

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

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

References octave::cdef_object.

◆ get()

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

Definition at line 266 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(), 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::m_rep.

Referenced by octave_classdef::is_instance_of(), 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_name()

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

Definition at line 167 of file cdef-property.h.

Referenced by octave::cdef_property::cdef_property_rep::check_get_access(), octave::cdef_property::cdef_property_rep::check_set_access(), octave::cdef_property::cdef_property_rep::err_property_access(), octave::cdef_class::cdef_class_rep::install_property(), octave_classdef::print_raw(), octave::property_get_defaultvalue(), and octave::cdef_property::cdef_property_rep::set_value().

◆ get_property()

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

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

◆ get_rep() [1/2]

cdef_property_rep * octave::cdef_property::get_rep ( void  )
inlineprivate

Definition at line 173 of file cdef-property.h.

References octave::cdef_object::get_rep().

◆ get_rep() [2/2]

const cdef_property_rep * octave::cdef_property::get_rep ( void  ) const
inlineprivate

Definition at line 178 of file cdef-property.h.

References octave::cdef_object::get_rep().

◆ get_value() [1/2]

octave_value octave::cdef_property::get_value ( bool  do_check_access = true,
const std::string &  who = "" 
) const
inline

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

◆ get_value() [2/2]

octave_value octave::cdef_property::get_value ( const cdef_object &  obj,
bool  do_check_access = true,
const std::string &  who = "" 
) const
inline

Definition at line 138 of file cdef-property.h.

Referenced by octave::class_getConstant(), octave::cdef_class::cdef_class_rep::meta_subsref(), octave_classdef::print_raw(), octave::cdef_object_scalar::subsasgn(), and octave::cdef_object_scalar::subsref().

◆ is()

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

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

References octave::cdef_object::m_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 251 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 678 of file cdef-object.h.

Referenced by octave_classdef_meta::doc_string(), octave_classdef_meta::file_name(), and octave_classdef_meta::is_classdef_constructor().

◆ is_constant()

bool octave::cdef_property::is_constant ( void  ) const
inline

Definition at line 169 of file cdef-property.h.

Referenced by octave::class_getConstant(), octave::cdef_class::cdef_class_rep::meta_subsref(), octave::cdef_object_scalar::subsasgn(), and octave::cdef_object_scalar::subsref().

◆ is_constructed()

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

Definition at line 317 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 319 of file cdef-object.h.

◆ is_handle_object()

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

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

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

◆ is_meta_object()

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

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

◆ is_method()

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

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

Referenced by octave_classdef_meta::is_classdef_method().

◆ is_package()

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

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

Referenced by octave_classdef_meta::is_package().

◆ is_partially_constructed_for()

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

Definition at line 324 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 680 of file cdef-object.h.

◆ is_value_object()

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

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

◆ make_array()

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

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

References octave::cdef_object.

Referenced by octave_classdef::undef_subsasgn().

◆ make_unique()

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

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

◆ map_keys()

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

Definition at line 304 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, Alloc >::dims(), octave::cdef_object::get_class(), octave::cdef_class::get_property_map(), octave::cdef_object::is_array(), Array< T, Alloc >::numel(), octave::cdef_object::ok(), octave::cdef_class::property_all, octave_map::setfield(), and warning_with_id().

◆ mark_as_constructed() [1/2]

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

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

◆ mark_as_constructed() [2/2]

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

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

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

◆ mark_for_construction()

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

Definition at line 312 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 695 of file cdef-object.h.

Referenced by octave_classdef_meta::accepts_postfix_index().

◆ meta_release()

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

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

Referenced by octave_classdef_meta::~octave_classdef_meta().

◆ 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 687 of file cdef-object.h.

Referenced by octave_classdef_meta::subsref().

◆ ok()

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

Definition at line 310 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(), 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(), octave::cdef_manager::find_package_symbol(), octave::cdef_class::cdef_class_rep::find_property(), in_class_method(), octave_classdef::is_instance_of(), 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_property & octave::cdef_property::operator= ( const cdef_property &  prop)
inline

Definition at line 129 of file cdef-property.h.

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

◆ put()

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

Definition at line 261 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 231 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_property()

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

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

◆ set_value()

void octave::cdef_property::set_value ( cdef_object &  obj,
const octave_value &  val,
bool  do_check_access = true,
const std::string &  who = "" 
)
inline

Definition at line 150 of file cdef-property.h.

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

◆ 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 297 of file cdef-object.h.

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

◆ subsref()

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

Referenced by octave_classdef::subsref(), and octave::cdef_object_scalar::subsref().

Friends And Related Function Documentation

◆ cdef_class

friend class cdef_class
friend

Definition at line 47 of file cdef-property.h.

Member Data Documentation

◆ m_rep

cdef_object_rep* octave::cdef_object::m_rep
privateinherited

Definition at line 348 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: