GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
array_property Class Reference

#include "graphics.h"

Inheritance diagram for array_property:
base_property row_vector_property

Public Member Functions

 array_property ()
 
 array_property (const array_property &p)
 
 array_property (const std::string &nm, const graphics_handle &h, const octave_value &m)
 
 ~array_property ()=default
 
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)
 
base_propertyclone () const
 
octave_value get () const
 
Matrix get_limits () const
 
double max_neg () const
 
double max_val () const
 
double min_pos () const
 
double min_val () const
 
array_propertyoperator= (const array_property &)=delete
 
array_propertyoperator= (const octave_value &val)
 
- Public Member Functions inherited from base_property
 base_property ()
 
 base_property (const base_property &p)
 
 base_property (const std::string &s, const graphics_handle &h)
 
virtual ~base_property ()=default
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
void delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
 
int get_id () const
 
std::string get_name () const
 
graphics_handle get_parent () const
 
bool is_hidden () const
 
virtual bool is_radio () const
 
bool ok () const
 
base_propertyoperator= (const base_property &)=delete
 
base_propertyoperator= (const octave_value &val)
 
void run_listeners (listener_mode mode=GCB_POSTSET)
 
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 () const
 
virtual std::string values_as_string () const
 

Protected Member Functions

bool do_set (const octave_value &v)
 

Protected Attributes

octave_value m_data
 
finite_type m_finite_constraint
 
double m_max_neg
 
double m_max_val
 
std::pair< double, bool > m_maxval
 
double m_min_pos
 
double m_min_val
 
std::pair< double, bool > m_minval
 
std::list< dim_vectorm_size_constraints
 
std::set< std::string > m_type_constraints
 

Detailed Description

Definition at line 1392 of file graphics.h.

Constructor & Destructor Documentation

◆ array_property() [1/3]

array_property::array_property ( )
inline

Definition at line 1395 of file graphics.h.

◆ array_property() [2/3]

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

Definition at line 1406 of file graphics.h.

◆ array_property() [3/3]

array_property::array_property ( const array_property p)
inline

Definition at line 1421 of file graphics.h.

◆ ~array_property()

array_property::~array_property ( )
default

Member Function Documentation

◆ add_constraint() [1/4]

void array_property::add_constraint ( const dim_vector dims)
inline

Definition at line 1441 of file graphics.h.

◆ add_constraint() [2/4]

void array_property::add_constraint ( const finite_type  finite)
inline

Definition at line 1444 of file graphics.h.

◆ add_constraint() [3/4]

◆ add_constraint() [4/4]

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

Definition at line 1447 of file graphics.h.

◆ clone()

base_property* array_property::clone ( ) const
inlinevirtual

Reimplemented from base_property.

Reimplemented in row_vector_property.

Definition at line 1478 of file graphics.h.

References m_finite_constraint, m_maxval, m_minval, m_size_constraints, and m_type_constraints.

◆ do_set()

bool array_property::do_set ( const octave_value v)
inlineprotectedvirtual

Reimplemented from base_property.

Reimplemented in row_vector_property.

Definition at line 1492 of file graphics.h.

References error(), octave_value::full_value(), and octave_value::issparse().

Referenced by row_vector_property::do_set().

◆ get()

octave_value array_property::get ( ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1436 of file graphics.h.

Referenced by axes::properties::get___colormap__(), axes::properties::get_alim(), image::properties::get_alim(), patch::properties::get_alim(), scatter::properties::get_alim(), surface::properties::get_alim(), hggroup::properties::get_alim(), image::properties::get_alphadata(), surface::properties::get_alphadata(), figure::properties::get_alphamap(), axes::properties::get_alphamap(), scatter::properties::get_annotation(), uitable::properties::get_backgroundcolor(), axes::properties::get_cameraposition(), axes::properties::get_cameratarget(), axes::properties::get_cameraupvector(), image::properties::get_cdata(), patch::properties::get_cdata(), scatter::properties::get_cdata(), surface::properties::get_cdata(), uicontrol::properties::get_cdata(), uipushtool::properties::get_cdata(), uitoggletool::properties::get_cdata(), axes::properties::get_clim(), image::properties::get_clim(), patch::properties::get_clim(), scatter::properties::get_clim(), surface::properties::get_clim(), hggroup::properties::get_clim(), figure::properties::get_colormap(), axes::properties::get_colororder(), uitable::properties::get_columneditable(), root_figure::properties::get_commandwindowsize(), figure::properties::get_currentpoint(), axes::properties::get_currentpoint(), axes::properties::get_dataaspectratio(), scatter::properties::get_datatiptemplate(), patch::properties::get_facenormals(), surface::properties::get_facenormals(), patch::properties::get_faces(), patch::properties::get_facevertexalphadata(), patch::properties::get_facevertexcdata(), scatter::properties::get_latitudedata(), scatter::properties::get_longitudedata(), axes::properties::get_looseinset(), root_figure::properties::get_monitorpositions(), figure::properties::get_outerposition(), axes::properties::get_outerposition(), figure::properties::get_paperposition(), figure::properties::get_papersize(), axes::properties::get_plotboxaspectratio(), root_figure::properties::get_pointerlocation(), figure::properties::get_pointershapecdata(), figure::properties::get_pointershapehotspot(), figure::properties::get_position(), axes::properties::get_position(), text::properties::get_position(), light::properties::get_position(), uicontextmenu::properties::get_position(), uicontrol::properties::get_position(), uibuttongroup::properties::get_position(), uipanel::properties::get_position(), uitable::properties::get_position(), scatter::properties::get_rdata(), root_figure::properties::get_screensize(), scatter::properties::get_seriesindex(), scatter::properties::get_sizedata(), uicontrol::properties::get_sliderstep(), scatter::properties::get_thetadata(), axes::properties::get_ticklength(), axes::properties::get_tightinset(), uicontrol::properties::get_value(), patch::properties::get_vertexnormals(), surface::properties::get_vertexnormals(), patch::properties::get_vertices(), axes::properties::get_view(), line::properties::get_xdata(), image::properties::get_xdata(), patch::properties::get_xdata(), scatter::properties::get_xdata(), surface::properties::get_xdata(), axes::properties::get_xlim(), line::properties::get_xlim(), text::properties::get_xlim(), image::properties::get_xlim(), patch::properties::get_xlim(), scatter::properties::get_xlim(), surface::properties::get_xlim(), hggroup::properties::get_xlim(), axes::properties::get_xminortickvalues(), axes::properties::get_xtick(), line::properties::get_ydata(), image::properties::get_ydata(), patch::properties::get_ydata(), scatter::properties::get_ydata(), surface::properties::get_ydata(), axes::properties::get_ylim(), line::properties::get_ylim(), text::properties::get_ylim(), image::properties::get_ylim(), patch::properties::get_ylim(), scatter::properties::get_ylim(), surface::properties::get_ylim(), hggroup::properties::get_ylim(), axes::properties::get_yminortickvalues(), axes::properties::get_ytick(), line::properties::get_zdata(), patch::properties::get_zdata(), scatter::properties::get_zdata(), surface::properties::get_zdata(), axes::properties::get_zlim(), line::properties::get_zlim(), text::properties::get_zlim(), patch::properties::get_zlim(), scatter::properties::get_zlim(), surface::properties::get_zlim(), hggroup::properties::get_zlim(), axes::properties::get_zminortickvalues(), and axes::properties::get_ztick().

◆ get_limits()

Matrix array_property::get_limits ( ) const
inline

Definition at line 1460 of file graphics.h.

References m.

Referenced by image::properties::pixel_xsize(), and image::properties::pixel_ysize().

◆ max_neg()

double array_property::max_neg ( ) const
inline

Definition at line 1458 of file graphics.h.

◆ max_val()

double array_property::max_val ( ) const
inline

Definition at line 1456 of file graphics.h.

◆ min_pos()

double array_property::min_pos ( ) const
inline

Definition at line 1457 of file graphics.h.

◆ min_val()

double array_property::min_val ( ) const
inline

Definition at line 1455 of file graphics.h.

◆ operator=() [1/2]

array_property& array_property::operator= ( const array_property )
delete

◆ operator=() [2/2]

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

Definition at line 1472 of file graphics.h.

Member Data Documentation

◆ m_data

octave_value array_property::m_data
protected

Definition at line 1521 of file graphics.h.

◆ m_finite_constraint

finite_type array_property::m_finite_constraint
protected

Definition at line 1528 of file graphics.h.

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

◆ m_max_neg

double array_property::m_max_neg
protected

Definition at line 1525 of file graphics.h.

◆ m_max_val

double array_property::m_max_val
protected

Definition at line 1523 of file graphics.h.

◆ m_maxval

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

Definition at line 1529 of file graphics.h.

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

◆ m_min_pos

double array_property::m_min_pos
protected

Definition at line 1524 of file graphics.h.

◆ m_min_val

double array_property::m_min_val
protected

Definition at line 1522 of file graphics.h.

◆ m_minval

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

Definition at line 1529 of file graphics.h.

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

◆ m_size_constraints

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

Definition at line 1527 of file graphics.h.

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

◆ m_type_constraints

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

Definition at line 1526 of file graphics.h.

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


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