CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::SelectDataStringPropertyBase Class Reference

#include <cxSelectDataStringPropertyBase.h>

Inheritance diagram for cx::SelectDataStringPropertyBase:
cx::StringPropertyBase cx::Property cx::StringPropertyActiveData cx::StringPropertyActiveImage cx::StringPropertyFusedInputOutputSelectData cx::StringPropertyRegistrationFixedImage cx::StringPropertyRegistrationMovingImage cx::StringPropertySelectData cx::StringPropertySelectImage cx::StringPropertySelectMesh cx::StringPropertySelectPointMetric cx::StringPropertySelectTrackedStream

Signals

void dataChanged (QString)
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 

Public Member Functions

virtual ~SelectDataStringPropertyBase ()
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QStringList getValueRange () const
 
virtual QString convertInternal2Display (QString internal)
 range of value. Use if data is constrained to a set. More...
 
virtual QString getHelp () const
 return a descriptive help string for the data, used for example as a tool tip. More...
 
virtual DataPtr getData () const
 
virtual DataPtr getData (QString uid) const
 
virtual void setValueName (const QString name)
 
virtual void setHelp (QString text)
 
virtual void setUidRegexp (QString regexp)
 
virtual void setTypeRegexp (QString regexp)
 
void setOnly2DImagesFilter (bool only2D)
 
- Public Member Functions inherited from cx::StringPropertyBase
 StringPropertyBase ()
 
virtual ~StringPropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual QString getUid () const
 
virtual bool setValue (const QString &value)=0
 set the data value. More...
 
virtual QString getValue () const =0
 get the data value. More...
 
virtual bool isReadOnly () const
 
virtual bool getAllowOnlyValuesInRange () const
 
virtual void setGuiRepresentation (GuiRepresentation type)
 
virtual GuiRepresentation getGuiRepresentation ()
 
- Public Member Functions inherited from cx::Property
 Property ()
 
virtual ~Property ()
 
virtual bool getEnabled () const
 Get the enabled/disabled state of the Property. More...
 
virtual bool getAdvanced () const
 Get the advanced flag of the adapter. More...
 
virtual QString getGroup () const
 Flag the adapter as part of a group. More...
 

Static Public Member Functions

static std::map< QString, DataPtrfilterOnType (std::map< QString, DataPtr > input, QString regexp)
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

Protected Member Functions

 SelectDataStringPropertyBase (PatientModelServicePtr patientModelService, QString typeRegexp=".*")
 
std::map< QString, DataPtrfilterOnUid (std::map< QString, DataPtr > input, QString regexp) const
 
std::map< QString, DataPtrfilterImagesOn2D (std::map< QString, DataPtr > input, bool only2D) const
 

Protected Attributes

QString mTypeRegexp
 
QString mUidRegexp
 
bool mOnly2D
 
QString mValueName
 
QString mHelp
 
PatientModelServicePtr mPatientModelService
 
- Protected Attributes inherited from cx::StringPropertyBase
GuiRepresentation mGuiRepresentation
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Additional Inherited Members

- Public Types inherited from cx::StringPropertyBase
enum  GuiRepresentation { grSTRING, grFILENAME }
 
- Public Slots inherited from cx::Property
virtual bool setEnabled (bool enabled)
 Set the enabled/disabled state of the Property. More...
 
virtual bool setAdvanced (bool advanced)
 Set the advanced flag of the adapter. More...
 
virtual bool setGroup (QString name)
 Flag the adapter as part of a group. More...
 

Detailed Description

Base class for all Properties that selects a Data or descendants.

Date
2014-09-11
Author
Christian Askeland, SINTEF
Ole Vegard Solberg, SINTEF

Definition at line 32 of file cxSelectDataStringPropertyBase.h.

Constructor & Destructor Documentation

virtual cx::SelectDataStringPropertyBase::~SelectDataStringPropertyBase ( )
inlinevirtual

Definition at line 36 of file cxSelectDataStringPropertyBase.h.

cx::SelectDataStringPropertyBase::SelectDataStringPropertyBase ( PatientModelServicePtr  patientModelService,
QString  typeRegexp = ".*" 
)
explicitprotected

Construct base with a filter that determined allowed Data types based on their getType() return value. The default of ".*" means any type.

Definition at line 21 of file cxSelectDataStringPropertyBase.cpp.

Member Function Documentation

QString cx::SelectDataStringPropertyBase::convertInternal2Display ( QString  internal)
virtual

range of value. Use if data is constrained to a set.

conversion from internal value to display value

Reimplemented from cx::StringPropertyBase.

Reimplemented in cx::StringPropertyFusedInputOutputSelectData.

Definition at line 119 of file cxSelectDataStringPropertyBase.cpp.

void cx::SelectDataStringPropertyBase::dataChanged ( QString  )
signal
std::map< QString, DataPtr > cx::SelectDataStringPropertyBase::filterImagesOn2D ( std::map< QString, DataPtr input,
bool  only2D 
) const
protected

Definition at line 76 of file cxSelectDataStringPropertyBase.cpp.

std::map< QString, DataPtr > cx::SelectDataStringPropertyBase::filterOnType ( std::map< QString, DataPtr input,
QString  regexp 
)
static

Erase all data with type not conforming to input regexp.

Definition at line 35 of file cxSelectDataStringPropertyBase.cpp.

std::map< QString, DataPtr > cx::SelectDataStringPropertyBase::filterOnUid ( std::map< QString, DataPtr input,
QString  regexp 
) const
protected

Erase all data with uid not conforming to input regexp.

Definition at line 60 of file cxSelectDataStringPropertyBase.cpp.

DataPtr cx::SelectDataStringPropertyBase::getData ( ) const
virtual
DataPtr cx::SelectDataStringPropertyBase::getData ( QString  uid) const
virtual

Definition at line 153 of file cxSelectDataStringPropertyBase.cpp.

QString cx::SelectDataStringPropertyBase::getDisplayName ( ) const
virtual

name of data entity. Used for display to user.

Implements cx::StringPropertyBase.

Reimplemented in cx::StringPropertyFusedInputOutputSelectData.

Definition at line 132 of file cxSelectDataStringPropertyBase.cpp.

QString cx::SelectDataStringPropertyBase::getHelp ( ) const
virtual

return a descriptive help string for the data, used for example as a tool tip.

Reimplemented from cx::StringPropertyBase.

Reimplemented in cx::StringPropertyFusedInputOutputSelectData.

Definition at line 127 of file cxSelectDataStringPropertyBase.cpp.

QStringList cx::SelectDataStringPropertyBase::getValueRange ( ) const
virtual

Reimplemented from cx::StringPropertyBase.

Reimplemented in cx::StringPropertyFusedInputOutputSelectData.

Definition at line 105 of file cxSelectDataStringPropertyBase.cpp.

void cx::SelectDataStringPropertyBase::setHelp ( QString  text)
virtual
void cx::SelectDataStringPropertyBase::setOnly2DImagesFilter ( bool  only2D)

Definition at line 93 of file cxSelectDataStringPropertyBase.cpp.

void cx::SelectDataStringPropertyBase::setTypeRegexp ( QString  regexp)
virtual

Definition at line 51 of file cxSelectDataStringPropertyBase.cpp.

void cx::SelectDataStringPropertyBase::setUidRegexp ( QString  regexp)
virtual

Definition at line 99 of file cxSelectDataStringPropertyBase.cpp.

void cx::SelectDataStringPropertyBase::setValueName ( const QString  name)
virtual

Member Data Documentation

QString cx::SelectDataStringPropertyBase::mHelp
protected

Definition at line 69 of file cxSelectDataStringPropertyBase.h.

bool cx::SelectDataStringPropertyBase::mOnly2D
protected

Definition at line 67 of file cxSelectDataStringPropertyBase.h.

PatientModelServicePtr cx::SelectDataStringPropertyBase::mPatientModelService
protected

Definition at line 71 of file cxSelectDataStringPropertyBase.h.

QString cx::SelectDataStringPropertyBase::mTypeRegexp
protected

Definition at line 65 of file cxSelectDataStringPropertyBase.h.

QString cx::SelectDataStringPropertyBase::mUidRegexp
protected

Definition at line 66 of file cxSelectDataStringPropertyBase.h.

QString cx::SelectDataStringPropertyBase::mValueName
protected

Definition at line 68 of file cxSelectDataStringPropertyBase.h.


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