Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Public Types | List of all members
Antares::Action::IAction Class Referenceabstract
Inheritance diagram for Antares::Action::IAction:
Antares::Action::AntaresStudy::Area::AllocationHydro Antares::Action::AntaresStudy::Area::AllocationHydroPost Antares::Action::AntaresStudy::Area::Color Antares::Action::AntaresStudy::Area::Correlation Antares::Action::AntaresStudy::Area::CorrelationPost Antares::Action::AntaresStudy::Area::Create Antares::Action::AntaresStudy::Area::DataTSGenerator Antares::Action::AntaresStudy::Area::DataTimeseries Antares::Action::AntaresStudy::Area::Filtering Antares::Action::AntaresStudy::Area::MiscGen Antares::Action::AntaresStudy::Area::NodalOptimization Antares::Action::AntaresStudy::Area::NodeTimeseries Antares::Action::AntaresStudy::Area::Position Antares::Action::AntaresStudy::Area::Reserves Antares::Action::AntaresStudy::Constraint::Comments Antares::Action::AntaresStudy::Constraint::Create Antares::Action::AntaresStudy::Constraint::Data Antares::Action::AntaresStudy::Constraint::Enabled Antares::Action::AntaresStudy::Constraint::Offsets Antares::Action::AntaresStudy::Constraint::Weights Antares::Action::AntaresStudy::Link::Comments Antares::Action::AntaresStudy::Link::CopperPlate Antares::Action::AntaresStudy::Link::Create Antares::Action::AntaresStudy::Link::Filtering Antares::Action::AntaresStudy::Link::HurdlesCost Antares::Action::AntaresStudy::Link::Impedances Antares::Action::AntaresStudy::Link::NTC Antares::Action::AntaresStudy::Link::UnloadData Antares::Action::AntaresStudy::ThermalCluster::CommonData Antares::Action::AntaresStudy::ThermalCluster::Create Antares::Action::AntaresStudy::ThermalCluster::RootNode Antares::Action::Settings::DecalAreaPosition Antares::Action::Settings::SuffixAreaName Antares::Action::Settings::SuffixConstraintName Antares::Action::Settings::SuffixPlantName Antares::Action::Text< AutoExpandT >

Public Types

using AncestorType = Yuni::Core::TreeN<IAction>
 The ancestor.
 
using Ptr = AncestorType::Ptr
 The most suitable smart ptr for the class.
 
using ThreadingPolicy = AncestorType::ThreadingPolicy
 The threading policy.
 
using Vector = std::vector<Ptr>
 Vector.
 
using iterator = AncestorType::iterator
 iterator
 

Public Member Functions

Constructor & Destructor
 IAction ()
 Default constructor.
 
virtual ~IAction ()
 Destructor.
 
Yuni::String caption () const
 Get the caption of the action.
 
Yuni::String message () const
 Get the message of the action.
 
bool prepare (Context &ctx)
 Make preparations for the execution.
 
void registerViews (Context &ctx)
 Register if possible the action into the appropriate view.
 
void datagridCaption (Yuni::String &title)
 
bool prepareRootNode (Context &ctx)
 Look for the root node and make preparations for the execution.
 
bool perform (Context &ctx, bool recursive=true)
 Perform the action.
 
void dump () const
 Dump the tree from this node to the stdcout.
 
virtual bool bold () const
 Get if the action should be represented with a bold font.
 
virtual bool autoExpand () const
 Auto-expand.
 
virtual bool canDoSomething () const
 
virtual bool allowUpdate () const
 
virtual bool allowSkip () const
 
virtual bool allowOverwrite () const
 
virtual bool shouldPrepareRootNode () const
 
virtual bool visible () const
 Get if the action should be visible to the user.
 
Behavior
Behavior behavior () const
 Get the behavior.
 
void behavior (Behavior newBehavior)
 Set the behavior.
 
bool prepareStack (Vector &vector)
 Prepare the whole list of actions to execute in the given order.
 
State
State state () const
 

UI

ActionInformations pInfos
 All data related to the action.
 
virtual void behaviorToText (Behavior behavior, Yuni::String &out)
 
void createPostActions (const IAction::Ptr &node)
 Create post actions if required.
 
virtual bool prepareWL (Context &ctx)=0
 Prepare the execution.
 
virtual void prepareSkipWL (Context &)
 Prepare the execution (when the behavior says that the action should be skipped)
 
virtual bool performWL (Context &ctx)=0
 Perform the action.
 
virtual void registerViewsWL (Context &)
 Register all views.
 
virtual void createPostActionsWL (const IAction::Ptr &node)
 Create post actions (if any)
 

Member Function Documentation

◆ autoExpand()

bool Antares::Action::IAction::autoExpand ( ) const
inlinevirtual

Auto-expand.

Reimplemented in Antares::Action::Settings::DecalAreaPosition, Antares::Action::Settings::SuffixAreaName, Antares::Action::Settings::SuffixConstraintName, Antares::Action::Settings::SuffixPlantName, and Antares::Action::Text< AutoExpandT >.

◆ bold()

bool Antares::Action::IAction::bold ( ) const
inlinevirtual

Get if the action should be represented with a bold font.

Reimplemented in Antares::Action::Text< AutoExpandT >.

◆ createPostActionsWL()

void Antares::Action::IAction::createPostActionsWL ( const IAction::Ptr & node)
inlineprotectedvirtual

Create post actions (if any)

Reimplemented in Antares::Action::AntaresStudy::Area::AllocationHydro, and Antares::Action::AntaresStudy::Area::Correlation.

◆ performWL()

virtual bool Antares::Action::IAction::performWL ( Context & ctx)
protectedpure virtual

Perform the action.

Implemented in Antares::Action::AntaresStudy::Area::AllocationHydro, Antares::Action::AntaresStudy::Area::AllocationHydroPost, Antares::Action::AntaresStudy::Area::Color, Antares::Action::AntaresStudy::Area::Correlation, Antares::Action::AntaresStudy::Area::CorrelationPost, Antares::Action::AntaresStudy::Area::Create, Antares::Action::AntaresStudy::Area::DataTimeseries, Antares::Action::AntaresStudy::Area::DataTSGenerator, Antares::Action::AntaresStudy::Area::Filtering, Antares::Action::AntaresStudy::Area::MiscGen, Antares::Action::AntaresStudy::Area::NodalOptimization, Antares::Action::AntaresStudy::Area::NodeTimeseries, Antares::Action::AntaresStudy::Area::Position, Antares::Action::AntaresStudy::Area::Reserves, Antares::Action::AntaresStudy::Constraint::Comments, Antares::Action::AntaresStudy::Constraint::Create, Antares::Action::AntaresStudy::Constraint::Data, Antares::Action::AntaresStudy::Constraint::Enabled, Antares::Action::AntaresStudy::Constraint::Offsets, Antares::Action::AntaresStudy::Constraint::Weights, Antares::Action::AntaresStudy::Link::Comments, Antares::Action::AntaresStudy::Link::CopperPlate, Antares::Action::AntaresStudy::Link::Create, Antares::Action::AntaresStudy::Link::Filtering, Antares::Action::AntaresStudy::Link::HurdlesCost, Antares::Action::AntaresStudy::Link::Impedances, Antares::Action::AntaresStudy::Link::NTC, Antares::Action::AntaresStudy::Link::UnloadData, Antares::Action::AntaresStudy::ThermalCluster::CommonData, Antares::Action::AntaresStudy::ThermalCluster::Create, Antares::Action::AntaresStudy::ThermalCluster::RootNode, Antares::Action::Settings::DecalAreaPosition, Antares::Action::Settings::SuffixAreaName, Antares::Action::Settings::SuffixConstraintName, Antares::Action::Settings::SuffixPlantName, and Antares::Action::Text< AutoExpandT >.

◆ prepareSkipWL()

virtual void Antares::Action::IAction::prepareSkipWL ( Context & )
inlineprotectedvirtual

Prepare the execution (when the behavior says that the action should be skipped)

Reimplemented in Antares::Action::AntaresStudy::Area::Create, Antares::Action::AntaresStudy::Constraint::Create, Antares::Action::AntaresStudy::ThermalCluster::RootNode, Antares::Action::Settings::DecalAreaPosition, Antares::Action::Settings::SuffixAreaName, Antares::Action::Settings::SuffixConstraintName, and Antares::Action::Settings::SuffixPlantName.

◆ prepareWL()

virtual bool Antares::Action::IAction::prepareWL ( Context & ctx)
protectedpure virtual

Prepare the execution.

Implemented in Antares::Action::AntaresStudy::Area::AllocationHydro, Antares::Action::AntaresStudy::Area::AllocationHydroPost, Antares::Action::AntaresStudy::Area::Color, Antares::Action::AntaresStudy::Area::Correlation, Antares::Action::AntaresStudy::Area::CorrelationPost, Antares::Action::AntaresStudy::Area::Create, Antares::Action::AntaresStudy::Area::DataTimeseries, Antares::Action::AntaresStudy::Area::DataTSGenerator, Antares::Action::AntaresStudy::Area::Filtering, Antares::Action::AntaresStudy::Area::MiscGen, Antares::Action::AntaresStudy::Area::NodalOptimization, Antares::Action::AntaresStudy::Area::NodeTimeseries, Antares::Action::AntaresStudy::Area::Position, Antares::Action::AntaresStudy::Area::Reserves, Antares::Action::AntaresStudy::Constraint::Comments, Antares::Action::AntaresStudy::Constraint::Create, Antares::Action::AntaresStudy::Constraint::Data, Antares::Action::AntaresStudy::Constraint::Enabled, Antares::Action::AntaresStudy::Constraint::Offsets, Antares::Action::AntaresStudy::Constraint::Weights, Antares::Action::AntaresStudy::Link::Comments, Antares::Action::AntaresStudy::Link::CopperPlate, Antares::Action::AntaresStudy::Link::Create, Antares::Action::AntaresStudy::Link::Filtering, Antares::Action::AntaresStudy::Link::HurdlesCost, Antares::Action::AntaresStudy::Link::Impedances, Antares::Action::AntaresStudy::Link::NTC, Antares::Action::AntaresStudy::Link::UnloadData, Antares::Action::AntaresStudy::ThermalCluster::CommonData, Antares::Action::AntaresStudy::ThermalCluster::Create, Antares::Action::AntaresStudy::ThermalCluster::RootNode, Antares::Action::Settings::DecalAreaPosition, Antares::Action::Settings::SuffixAreaName, Antares::Action::Settings::SuffixConstraintName, Antares::Action::Settings::SuffixPlantName, and Antares::Action::Text< AutoExpandT >.

◆ registerViewsWL()

virtual void Antares::Action::IAction::registerViewsWL ( Context & )
inlineprotectedvirtual

Register all views.

Reimplemented in Antares::Action::AntaresStudy::Area::DataTimeseries, and Antares::Action::AntaresStudy::Area::DataTSGenerator.

◆ visible()

bool Antares::Action::IAction::visible ( ) const
inlinevirtual

Get if the action should be visible to the user.

Reimplemented in Antares::Action::AntaresStudy::Area::AllocationHydroPost, Antares::Action::AntaresStudy::Area::CorrelationPost, and Antares::Action::AntaresStudy::Link::UnloadData.

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