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

#include "graphics.in.h"

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

Public Member Functions

 array_property (const array_property &p)
 
 array_property (const std::string &nm, const graphics_handle &h, const octave_value &m)
 
 array_property (void)
 
void add_constraint (const dim_vector &dims)
 
void add_constraint (const finite_type finite)
 
void add_constraint (const std::string &type)
 
void add_constraint (const std::string &type, double val, bool inclusive)
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
base_property * clone (void) const
 
void delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
 
octave_value get (void) const
 
int get_id (void) const
 
Matrix get_limits (void) const
 
std::string get_name (void) const
 
graphics_handle get_parent (void) const
 
bool is_hidden (void) const
 
virtual bool is_radio (void) const
 
double max_neg (void) const
 
double max_val (void) const
 
double min_pos (void) const
 
double min_val (void) const
 
bool ok (void) const
 
array_property & operator= (const octave_value &val)
 
OCTINTERP_API void run_listeners (listener_mode mode=GCB_POSTSET)
 
OCTINTERP_API bool set (const octave_value &v, bool do_run=true, bool do_notify_toolkit=true)
 
void set_hidden (bool flag)
 
void set_id (int d)
 
void set_name (const std::string &s)
 
void set_parent (const graphics_handle &h)
 
virtual Cell values_as_cell (void) const
 
virtual std::string values_as_string (void) const
 

Protected Member Functions

bool do_set (const octave_value &v)
 

Protected Attributes

octave_value data
 
finite_type finite_constraint
 
std::pair< double, bool > maxval
 
std::pair< double, bool > minval
 
std::list< dim_vector > size_constraints
 
std::set< std::string > type_constraints
 
double xmax
 
double xmaxp
 
double xmin
 
double xminp
 

Private Types

typedef std::map< listener_mode, octave_value_list > listener_map
 
typedef std::map< listener_mode, octave_value_list >::const_iterator listener_map_const_iterator
 
typedef std::map< listener_mode, octave_value_list >::iterator listener_map_iterator
 

Private Member Functions

OCTINTERP_API void get_data_limits (void)
 
OCTINTERP_API bool is_equal (const octave_value &v) const
 
OCTINTERP_API bool validate (const octave_value &v)
 

Private Attributes

octave::refcount< octave_idx_type > count
 
bool hidden
 
int id
 
listener_map listeners
 
std::string name
 
graphics_handle parent
 

Detailed Description

Definition at line 1369 of file graphics.in.h.

Member Typedef Documentation

◆ listener_map

typedef std::map<listener_mode, octave_value_list> base_property::listener_map
privateinherited

Definition at line 416 of file graphics.in.h.

◆ listener_map_const_iterator

typedef std::map<listener_mode, octave_value_list>::const_iterator base_property::listener_map_const_iterator
privateinherited

Definition at line 420 of file graphics.in.h.

◆ listener_map_iterator

typedef std::map<listener_mode, octave_value_list>::iterator base_property::listener_map_iterator
privateinherited

Definition at line 418 of file graphics.in.h.

Constructor & Destructor Documentation

◆ array_property() [1/3]

array_property::array_property ( void  )
inline

Definition at line 1372 of file graphics.in.h.

References get_data_limits().

Referenced by clone().

◆ array_property() [2/3]

array_property::array_property ( const std::string &  nm,
const graphics_handle &  h,
const octave_value &  m 
)
inline

Definition at line 1382 of file graphics.in.h.

References get_data_limits().

◆ array_property() [3/3]

array_property::array_property ( const array_property &  p)
inline

Definition at line 1396 of file graphics.in.h.

Member Function Documentation

◆ add_constraint() [1/4]

void array_property::add_constraint ( const dim_vector &  dims)
inline

Definition at line 1409 of file graphics.in.h.

References size_constraints.

◆ add_constraint() [2/4]

void array_property::add_constraint ( const finite_type  finite)
inline

Definition at line 1412 of file graphics.in.h.

References finite_constraint.

◆ add_constraint() [3/4]

void array_property::add_constraint ( const std::string &  type)
inline

Definition at line 1406 of file graphics.in.h.

References type_constraints.

Referenced by row_vector_property::add_constraint().

◆ add_constraint() [4/4]

void array_property::add_constraint ( const std::string &  type,
double  val,
bool  inclusive 
)
inline

Definition at line 1415 of file graphics.in.h.

References maxval, and minval.

◆ add_listener()

void base_property::add_listener ( const octave_value &  v,
listener_mode  mode = GCB_POSTSET 
)
inlineinherited

Definition at line 347 of file graphics.in.h.

References octave_value_list::length(), base_property::listeners, and octave_value_list::resize().

Referenced by property::add_listener().

◆ clone()

base_property* array_property::clone ( void  ) const
inlinevirtual

Reimplemented from base_property.

Reimplemented in row_vector_property.

Definition at line 1446 of file graphics.in.h.

References array_property(), finite_constraint, maxval, minval, size_constraints, and type_constraints.

◆ delete_listener()

void base_property::delete_listener ( const octave_value &  v = octave_value (),
listener_mode  mode = GCB_POSTSET 
)
inlineinherited

Definition at line 353 of file graphics.in.h.

References GCB_PERSISTENT, octave_value_list::length(), base_property::listeners, and octave_value_list::resize().

Referenced by property::delete_listener().

◆ do_set()

bool array_property::do_set ( const octave_value &  v)
inlineprotectedvirtual

Reimplemented from base_property.

Reimplemented in row_vector_property.

Definition at line 1460 of file graphics.in.h.

References data, error(), octave_value::full_value(), get_data_limits(), base_property::get_name(), is_equal(), octave_value::issparse(), and validate().

Referenced by row_vector_property::do_set().

◆ get()

octave_value array_property::get ( void  ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1404 of file graphics.in.h.

References data.

◆ get_data_limits()

void array_property::get_data_limits ( void  )
private

Definition at line 1691 of file graphics.cc.

References octave_value::array_value(), data, get_array_limits(), Inf, octave_value::int16_array_value(), octave_value::int32_array_value(), octave_value::int64_array_value(), octave_value::int8_array_value(), octave_value::is_int16_type(), octave_value::is_int32_type(), octave_value::is_int64_type(), octave_value::is_int8_type(), octave_value::is_uint16_type(), octave_value::is_uint32_type(), octave_value::is_uint64_type(), octave_value::is_uint8_type(), octave_value::isempty(), octave_value::isinteger(), octave_value::uint16_array_value(), octave_value::uint32_array_value(), octave_value::uint64_array_value(), octave_value::uint8_array_value(), xmax, xmaxp, xmin, and xminp.

Referenced by array_property(), and do_set().

◆ get_id()

int base_property::get_id ( void  ) const
inlineinherited

Definition at line 317 of file graphics.in.h.

References base_property::id.

Referenced by property::get_id().

◆ get_limits()

Matrix array_property::get_limits ( void  ) const
inline

Definition at line 1428 of file graphics.in.h.

References m, max_neg(), max_val(), min_pos(), and min_val().

◆ get_name()

std::string base_property::get_name ( void  ) const
inlineinherited

Definition at line 303 of file graphics.in.h.

References base_property::name.

Referenced by string_array_property::string_array_property(), double_radio_property::current_value(), radio_property::do_set(), color_property::do_set(), double_property::do_set(), double_radio_property::do_set(), do_set(), handle_property::do_set(), callback_property::do_set(), string_property::do_set(), string_array_property::do_set(), text_label_property::do_set(), double_radio_property::double_value(), property::get_name(), and validate().

◆ get_parent()

graphics_handle base_property::get_parent ( void  ) const
inlineinherited

Definition at line 307 of file graphics.in.h.

References base_property::parent.

Referenced by callback_property::execute(), and property::get_parent().

◆ is_equal()

bool array_property::is_equal ( const octave_value &  v) const
private

Definition at line 1632 of file graphics.cc.

References CHECK_ARRAY_EQUAL, data, octave_value::dims(), octave_value::is_double_type(), octave_value::is_int16_type(), octave_value::is_int32_type(), octave_value::is_int64_type(), octave_value::is_int8_type(), octave_value::is_single_type(), octave_value::is_uint16_type(), octave_value::is_uint32_type(), octave_value::is_uint64_type(), octave_value::is_uint8_type(), octave_value::islogical(), and octave_value::type_name().

Referenced by do_set().

◆ is_hidden()

bool base_property::is_hidden ( void  ) const
inlineinherited

Definition at line 311 of file graphics.in.h.

References base_property::hidden.

Referenced by property::is_hidden().

◆ is_radio()

virtual bool base_property::is_radio ( void  ) const
inlinevirtualinherited

Reimplemented in double_radio_property, color_property, and radio_property.

Definition at line 315 of file graphics.in.h.

Referenced by property::is_radio().

◆ max_neg()

double array_property::max_neg ( void  ) const
inline

Definition at line 1426 of file graphics.in.h.

References xmaxp.

Referenced by get_limits().

◆ max_val()

double array_property::max_val ( void  ) const
inline

Definition at line 1424 of file graphics.in.h.

References xmax.

Referenced by get_limits().

◆ min_pos()

double array_property::min_pos ( void  ) const
inline

Definition at line 1425 of file graphics.in.h.

References xminp.

Referenced by get_limits().

◆ min_val()

double array_property::min_val ( void  ) const
inline

Definition at line 1423 of file graphics.in.h.

References xmin.

Referenced by get_limits().

◆ ok()

bool base_property::ok ( void  ) const
inlineinherited

Definition at line 301 of file graphics.in.h.

References octave_handle::ok(), and base_property::parent.

Referenced by property::ok().

◆ operator=()

array_property& array_property::operator= ( const octave_value &  val)
inline

Definition at line 1440 of file graphics.in.h.

References base_property::set().

◆ run_listeners()

void base_property::run_listeners ( listener_mode  mode = GCB_POSTSET)
inherited

Definition at line 1283 of file graphics.cc.

References octave::__get_gh_manager__(), gh_manager::execute_listener(), octave_value_list::length(), base_property::listeners, and base_property::parent.

Referenced by property::run_listeners(), and base_property::set().

◆ set()

bool base_property::set ( const octave_value &  v,
bool  do_run = true,
bool  do_notify_toolkit = true 
)
inherited

Definition at line 1257 of file graphics.cc.

References octave::__get_gh_manager__(), base_property::do_set(), GCB_POSTSET, gh_manager::get_object(), base_property::parent, base_property::run_listeners(), and graphics_object::update().

Referenced by base_property::operator=(), string_property::operator=(), string_array_property::operator=(), text_label_property::operator=(), radio_property::operator=(), color_property::operator=(), double_property::operator=(), double_radio_property::operator=(), operator=(), row_vector_property::operator=(), bool_property::operator=(), handle_property::operator=(), any_property::operator=(), children_property::operator=(), callback_property::operator=(), and property::set().

◆ set_hidden()

void base_property::set_hidden ( bool  flag)
inlineinherited

Definition at line 313 of file graphics.in.h.

References base_property::hidden.

Referenced by property::set_hidden().

◆ set_id()

void base_property::set_id ( int  d)
inlineinherited

Definition at line 319 of file graphics.in.h.

References d.

Referenced by property::set_id().

◆ set_name()

void base_property::set_name ( const std::string &  s)
inlineinherited

Definition at line 305 of file graphics.in.h.

References base_property::name.

Referenced by property::set_name().

◆ set_parent()

void base_property::set_parent ( const graphics_handle &  h)
inlineinherited

Definition at line 309 of file graphics.in.h.

References base_property::parent.

Referenced by property::set_parent().

◆ validate()

bool array_property::validate ( const octave_value &  v)
private

Definition at line 1525 of file graphics.cc.

References octave_value::array_value(), octave_value::class_name(), octave_value::dims(), error(), FINITE, finite_constraint, base_property::get_name(), octave_value::is_bool_scalar(), octave_value::iscomplex(), octave_value::isempty(), octave::math::isfinite(), octave::math::isinf(), octave::math::isnan(), octave_value::isnumeric(), maxval, minval, dim_vector::ndims(), NO_CHECK, NOT_INF, NOT_NAN, Array< T >::numel(), size_constraints, and type_constraints.

Referenced by do_set().

◆ values_as_cell()

virtual Cell base_property::values_as_cell ( void  ) const
inlinevirtualinherited

Reimplemented in color_property, and radio_property.

Definition at line 336 of file graphics.in.h.

References error(), and base_property::name.

Referenced by property::values_as_cell().

◆ values_as_string()

virtual std::string base_property::values_as_string ( void  ) const
inlinevirtualinherited

Reimplemented in color_property, and radio_property.

Definition at line 331 of file graphics.in.h.

References error(), and base_property::name.

Referenced by property::values_as_string().

Member Data Documentation

◆ count

octave::refcount<octave_idx_type> base_property::count
privateinherited

Definition at line 424 of file graphics.in.h.

Referenced by property::property(), property::~property(), and property::operator=().

◆ data

octave_value array_property::data
protected

Definition at line 1489 of file graphics.in.h.

Referenced by do_set(), row_vector_property::do_set(), get(), get_data_limits(), and is_equal().

◆ finite_constraint

finite_type array_property::finite_constraint
protected

Definition at line 1496 of file graphics.in.h.

Referenced by add_constraint(), clone(), row_vector_property::clone(), and validate().

◆ hidden

bool base_property::hidden
privateinherited

Definition at line 427 of file graphics.in.h.

Referenced by base_property::is_hidden(), and base_property::set_hidden().

◆ id

int base_property::id
privateinherited

Definition at line 423 of file graphics.in.h.

Referenced by base_property::get_id().

◆ listeners

listener_map base_property::listeners
privateinherited

Definition at line 428 of file graphics.in.h.

Referenced by base_property::add_listener(), base_property::delete_listener(), and base_property::run_listeners().

◆ maxval

std::pair<double, bool> array_property::maxval
protected

Definition at line 1497 of file graphics.in.h.

Referenced by add_constraint(), clone(), row_vector_property::clone(), and validate().

◆ minval

std::pair<double, bool> array_property::minval
protected

Definition at line 1497 of file graphics.in.h.

Referenced by add_constraint(), clone(), row_vector_property::clone(), and validate().

◆ name

std::string base_property::name
privateinherited

Definition at line 425 of file graphics.in.h.

Referenced by base_property::do_set(), base_property::get(), base_property::get_name(), base_property::set_name(), base_property::values_as_cell(), and base_property::values_as_string().

◆ parent

graphics_handle base_property::parent
privateinherited

Definition at line 426 of file graphics.in.h.

Referenced by base_property::get_parent(), base_property::ok(), base_property::run_listeners(), base_property::set(), and base_property::set_parent().

◆ size_constraints

std::list<dim_vector> array_property::size_constraints
protected

Definition at line 1495 of file graphics.in.h.

Referenced by add_constraint(), row_vector_property::add_constraint(), clone(), row_vector_property::clone(), and validate().

◆ type_constraints

std::set<std::string> array_property::type_constraints
protected

Definition at line 1494 of file graphics.in.h.

Referenced by add_constraint(), clone(), row_vector_property::clone(), and validate().

◆ xmax

double array_property::xmax
protected

Definition at line 1491 of file graphics.in.h.

Referenced by get_data_limits(), and max_val().

◆ xmaxp

double array_property::xmaxp
protected

Definition at line 1493 of file graphics.in.h.

Referenced by get_data_limits(), and max_neg().

◆ xmin

double array_property::xmin
protected

Definition at line 1490 of file graphics.in.h.

Referenced by get_data_limits(), and min_val().

◆ xminp

double array_property::xminp
protected

Definition at line 1492 of file graphics.in.h.

Referenced by get_data_limits(), and min_pos().

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