SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Slots | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
smtk::extension::qtAnalysisView Class Reference

Provides the QT UI for an Analysis View. More...

#include <qtAnalysisView.h>

Inheritance diagram for smtk::extension::qtAnalysisView:
[legend]
Collaboration diagram for smtk::extension::qtAnalysisView:
[legend]

Public Slots

void analysisAttributeChanged ()
 Slot used to update the UI when Analysis Attribute changes.
 
- Public Slots inherited from smtk::extension::qtBaseAttributeView
virtual void updateModelAssociation ()
 
virtual void valueChanged (smtk::attribute::ItemPtr)
 
virtual void attributeCreated (const smtk::attribute::AttributePtr &)
 Invoke the Signal dummy operation to indicate an attribute has been created.
 
virtual void attributeChanged (const smtk::attribute::AttributePtr &, std::vector< std::string > items=std::vector< std::string >())
 Invoke the Signal dummy operation to indicate an attribute has been changed (renamed).
 
virtual void attributeRemoved (const smtk::attribute::AttributePtr &)
 Invoke the Signal dummy operation to indicate an attribute has been removed.
 
void showAdvanceLevel (int i) override
 
void enableShowBy (int) override
 
void onInfo () override
 
virtual void requestModelEntityAssociation ()
 
- Public Slots inherited from smtk::extension::qtBaseView
virtual void updateUI ()
 Have the view update its contents. More...
 
virtual void childrenResized ()
 
virtual void showAdvanceLevelOverlay (bool val)
 
virtual void showAdvanceLevel (int)
 Have the view update its contents based on a new advance level.
 
virtual void enableShowBy (int)
 
virtual void onInfo ()
 Display view information (i.e., help text)
 
virtual void onShowCategory ()
 

Public Member Functions

 smtkTypenameMacro (qtAnalysisView)
 
 qtAnalysisView (const smtk::view::Information &info)
 
bool isValid () const override
 Return true if the view's contents are valid.
 
- Public Member Functions inherited from smtk::extension::qtBaseAttributeView
 smtkTypenameMacro (qtBaseAttributeView)
 
 qtBaseAttributeView (const smtk::view::Information &info)
 
void setInitialCategory () override
 When category filtering is requested to be either on by default or is requested to be on permanently, we need to have a mechanism to force the views to display info based on the initial category. More...
 
virtual bool displayItem (smtk::attribute::ItemPtr) const
 Determines if an item should be displayed. More...
 
virtual bool displayItemDefinition (const smtk::attribute::ItemDefinitionPtr &) const
 
virtual bool isItemWriteable (const smtk::attribute::ItemPtr &) const
 Determines if an item can be modified.
 
virtual void getDefinitions (smtk::attribute::DefinitionPtr attDef, QList< smtk::attribute::DefinitionPtr > &defs)
 
int fixedLabelWidth ()
 
bool setFixedLabelWidth (int w)
 
bool advanceLevelVisible ()
 
bool useSelectionManager () const
 
int advanceLevel () const override
 
bool categoryEnabled () const override
 
std::string currentCategory () const override
 
bool isEmpty () const override
 Return true if the view does not contain any information to display. More...
 
void setIgnoreCategories (bool mode)
 
bool ignoreCategories () const
 
smtk::attribute::ResourcePtr attributeResource () const
 Return the attribute resource used by this View.
 
- Public Member Functions inherited from smtk::extension::qtBaseView
 smtkTypenameMacro (qtBaseView)
 
 qtBaseView (const smtk::view::Information &info)
 
const smtk::view::ConfigurationPtrconfiguration () const
 
QWidget * widget () const
 
QWidget * parentWidget () const
 
qtUIManageruiManager () const
 
bool isTopLevel () const
 
- Public Member Functions inherited from smtk::view::BaseView
 smtkTypenameMacroBase (BaseView)
 
virtual std::size_t index () const
 index is a compile-time intrinsic of the derived view; as such, it cannot be set.
 

Static Public Member Functions

static qtBaseViewcreateViewWidget (const smtk::view::Information &info)
 Factory method to create a qtAnalysisView from a smtk::view::Information.
 
- Static Public Member Functions inherited from smtk::extension::qtBaseAttributeView
static bool validateInformation (const smtk::view::Information &info)
 
- Static Public Member Functions inherited from smtk::extension::qtBaseView
static bool validateInformation (const smtk::view::Information &info)
 

Protected Member Functions

void createWidget () override
 Creates the main QT Widget that is associated with a View. More...
 
void processAnalysisItem (smtk::attribute::ConstItemPtr item, std::set< std::string > &cats)
 Method to assembly the categories represented by an item in the Analysis Attribute.
 
bool categoryTest (const smtk::attribute::ItemPtr &) const override
 Override's qtBaseView Test. More...
 
void analysisChanged (bool attributeChanged)
 Method to update the category filtering based on the state of the Analysis Attribute.
 
- Protected Member Functions inherited from smtk::extension::qtBaseAttributeView
void buildUI () override
 Create the UI related to the view and assigns it to the parent widget.
 
void makeTopLevel () override
 Adds properties associated with respects to a top level view.
 
bool checkStatus (const smtk::attribute::Attribute *att) const
 Returns true if |att| is valid.
 
virtual bool advanceLevelTest (const smtk::attribute::ItemPtr &) const
 Test for advance level filtering. More...
 
void topLevelPrepCategories (const smtk::view::ConfigurationPtr &view, const smtk::attribute::ResourcePtr &attResource)
 
void topLevelPrepConfigurations (const smtk::view::ConfigurationPtr &view, const smtk::attribute::ResourcePtr &attResource)
 
void topLevelPrepAdvanceLevels (const smtk::view::ConfigurationPtr &view)
 
void prepConfigurationComboBox (const std::string &newConfigurationName)
 
void checkConfigurations (smtk::attribute::ItemPtr &item)
 
- Protected Member Functions inherited from smtk::extension::qtBaseView
virtual void setInfoToBeDisplayed ()
 Set the information to be displayed in the ViewInfoDialog.
 

Additional Inherited Members

- Signals inherited from smtk::extension::qtBaseAttributeView
void modified (smtk::attribute::ItemPtr)
 
- Signals inherited from smtk::extension::qtBaseView
void aboutToDestroy ()
 
void modified ()
 
- Protected Slots inherited from smtk::extension::qtBaseAttributeView
virtual void onAdvanceLevelChanged (int levelIdx)
 
void onConfigurationChanged (int levelIdx)
 
- Protected Attributes inherited from smtk::extension::qtBaseAttributeView
QScrollArea * m_ScrollArea
 
bool m_topLevelInitialized
 
bool m_topLevelCanCreateConfigurations
 
smtk::attribute::WeakDefinitionPtr m_topLevelConfigurationDef
 
bool m_ignoreCategories
 
std::string m_addressString
 
- Protected Attributes inherited from smtk::extension::qtBaseView
QWidget * Widget
 
bool m_isTopLevel
 
bool m_useSelectionManager
 
smtk::view::Information m_viewInfo
 
QPointer< qtViewInfoDialogm_infoDialog
 
bool m_advOverlayVisible
 

Detailed Description

Provides the QT UI for an Analysis View.

An Analysis View is a specialized view for choosing the types of analyses the user wants to perform. These choices are persistent and can be used by an export operation instead of having the operator ask the user what types of analyses should be performed.

Unlike other views the Analysis View will construct both an Attribute Definition and corresponding Attribute when needed. The Attribute Definition is based on the Analysis Information stored in the Attribute Resource. Any Analysis that is referred to by another will be represented as a Group Item. All other Analyses will be represented as a Void Item.

The View also controls which categories are permitted to be displayed and/or selected. The set is union of all of the selected Analyses' categories.

The following is an example of a Analysis View:

<View Type="Analysis" Title="Analysis" AnalysisAttributeName="truchasAnalysis" AnalysisAttributeType="truchasAnalysisDefinition">
</View>

AnalysisAttributeType is the name of the Attribute Definition the view will create to represent the Analysis Structure (if needed)

AnalysisAttributeName is the name of the Attribute the view will create to represent the Analysis (if needed)

See also
qtBaseAttributeView

Member Function Documentation

◆ categoryTest()

bool qtAnalysisView::categoryTest ( const smtk::attribute::ItemPtr ) const
overrideprotectedvirtual

Override's qtBaseView Test.

Since the items of the Analysis Attribute have no categories, this view turns off this

Reimplemented from smtk::extension::qtBaseAttributeView.

◆ createWidget()

void qtAnalysisView::createWidget ( )
overrideprotectedvirtual

Creates the main QT Widget that is associated with a View.

Typically this is the only method a derived View needs to override.

Reimplemented from smtk::extension::qtBaseView.


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