Seg3D  2.4
Seg3D is a free volume segmentation and processing tool developed by the NIH Center for Integrative Biomedical Computing at the University of Utah Scientific Computing and Imaging (SCI) Institute.
Public Member Functions | Protected Member Functions | Friends | List of all members
Core::StateRangedValueBase Class Referenceabstract

This pure virtual class defines an extra interface that StateValue provides. More...

#include <StateRangedValue.h>

Inheritance diagram for Core::StateRangedValueBase:
Core::StateBase Core::StateRangedValue< T >

Public Member Functions

 StateRangedValueBase (const std::string &stateid)
 
- Public Member Functions inherited from Core::StateBase
 StateBase (const std::string &stateid)
 
virtual std::string export_to_string () const =0
 Convert the contents of the State into a string.
 
virtual bool import_from_string (const std::string &str, Core::ActionSource source=Core::ActionSource::NONE_E)=0
 Set the State from a string.
 
void set_is_project_data (bool is_project_data)
 Set whether the data is part of the project data.
 
void set_locked (bool locked)
 
bool get_locked () const
 Query whether the variable has been designated as locked.
 
int get_session_priority () const
 Get the priority in which loading sets the states.
 
void set_session_priority (int priority)
 By default the priority is set to DEAFULT_LOAD_E.
 
std::string get_stateid () const
 Get the unique id assigned to the state variable.
 
bool is_project_data () const
 Whether the data is tagged as project data that is saved in a session.
 

Protected Member Functions

virtual bool import_offset_from_variant (Variant &variant, ActionSource source=ActionSource::NONE_E)=0
 Import the offset value from the variant and apply it to the current value.
 
virtual bool import_range_from_variant (Variant &variant_min, Variant &variant_max, ActionSource source=ActionSource::NONE_E)=0
 Import range values from variants.
 
virtual bool validate_value_type_variant (Variant &variant, std::string &error)=0
 Returns true if the value stored in the variant is a valid offset value, otherwise false.
 
- Protected Member Functions inherited from Core::StateBase
virtual void export_to_variant (Variant &variant) const =0
 Export the state data to a variant parameter.
 
virtual bool import_from_variant (Variant &variant, Core::ActionSource source=Core::ActionSource::NONE_E)=0
 Import the state data from a variant parameter.
 
virtual bool validate_variant (Variant &variant, std::string &error)=0
 
void enable_signals (bool signals_enabled)
 
bool signals_enabled ()
 Check whether signals are enabled.
 
void set_initializing (bool initializing)
 
bool get_initializing () const
 Query whether the state variable and its parent are still being initialized.
 
virtual void invalidate ()
 

Friends

class ActionOffset
 
class ActionSetRange
 

Additional Inherited Members

- Public Types inherited from Core::StateBase
enum  { DO_NOT_LOAD_E = -1, LOAD_LAST_E = 0, DEFAULT_LOAD_E = 100 }
 
typedef boost::signals2::signal< void() > state_changed_signal_type
 This signal is triggered when the state is changed.
 
- Public Attributes inherited from Core::StateBase
state_changed_signal_type state_changed_signal_
 

Detailed Description

This pure virtual class defines an extra interface that StateValue provides.


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