SDFormat Editor
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SaveFileCommand Class Reference

Save model command implementation of CommandI. More...

#include <SaveFileCommand.h>

Inheritance diagram for SaveFileCommand:
Inheritance graph
Collaboration diagram for SaveFileCommand:
Collaboration graph

Public Member Functions

 SaveFileCommand (std::shared_ptr< GUII > gui, std::shared_ptr< SDFormatParserI > sdformatParser)
 Constructor for save model command objects.
 

Private Member Functions

bool Execute ()
 Implementation of interface method.
 
bool ExecuteUndo () override
 Implementation of interface method.
 
bool ExecuteRedo () override
 Implementation of interface method.
 
bool IsUndoable () override
 Implementation of interface method.
 
bool IsRedoable () override
 Implementation of interface method.
 
bool IsThreaded (bool &prevent_user_input) override
 Implementation of interface method.
 
bool ChangesProgramStateIrreversibly () override
 Implementation of interface method.
 

Private Attributes

std::shared_ptr< GUIIgui
 Pointer to the gui interface.
 
std::shared_ptr< SDFormatParserIsdformatParser
 Pointer to the sdformat parser interface.
 

Detailed Description

Save model command implementation of CommandI.

Constructor & Destructor Documentation

◆ SaveFileCommand()

SaveFileCommand::SaveFileCommand ( std::shared_ptr< GUII gui,
std::shared_ptr< SDFormatParserI sdformatParser 
)

Constructor for save model command objects.

Parameters
[in]guiPointer to the GUII object
[in]sdformatParserPointer to the SDFormatParserI object

Member Function Documentation

◆ ChangesProgramStateIrreversibly()

bool SaveFileCommand::ChangesProgramStateIrreversibly ( )
overrideprivatevirtual

Implementation of interface method.

Returns
Always false

Implements CommandI.

◆ Execute()

bool SaveFileCommand::Execute ( )
privatevirtual

Implementation of interface method.

Returns
True if the file has been successfully saved

Implements CommandI.

◆ ExecuteRedo()

bool SaveFileCommand::ExecuteRedo ( )
overrideprivatevirtual

Implementation of interface method.

Returns
Always false

Implements CommandI.

◆ ExecuteUndo()

bool SaveFileCommand::ExecuteUndo ( )
overrideprivatevirtual

Implementation of interface method.

Returns
Always false

Implements CommandI.

◆ IsRedoable()

bool SaveFileCommand::IsRedoable ( )
overrideprivatevirtual

Implementation of interface method.

Returns
Always false

Implements CommandI.

◆ IsThreaded()

bool SaveFileCommand::IsThreaded ( bool &  prevent_user_input)
overrideprivatevirtual

Implementation of interface method.

Parameters
[out]prevent_user_inputindicates if user input should be prevented if this happens to be a threaded command
Returns
Always false

Implements CommandI.

◆ IsUndoable()

bool SaveFileCommand::IsUndoable ( )
overrideprivatevirtual

Implementation of interface method.

Returns
Always false

Implements CommandI.


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