* \ingroup Plugins
* \brief Feature for export shapes to the external files in CAD formats.
*
- * The set of supported formats is defined in the configuration file.
+ * The list of supported formats is defined in the configuration file.
*/
class ExchangePlugin_ExportFeature : public ModelAPI_Feature
{
static const std::string MY_SELECTION_LIST_ID("selection_list");
return MY_SELECTION_LIST_ID;
}
- /// default constructor
+ /// Default constructor
EXCHANGEPLUGIN_EXPORT ExchangePlugin_ExportFeature();
- /// default destructor
+ /// Default destructor
EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ExportFeature();
/// Request for initialization of data model of the feature: adding all attributes
* \ingroup Plugins
* \brief Feature for import shapes from the external files in CAD formats.
*
- * The set of supported formats is defined in the configuration file.
+ * The list of supported formats is defined in the configuration file.
*/
class ExchangePlugin_ImportFeature : public ModelAPI_Feature
{
static const std::string MY_IMPORT_ID("Import");
return MY_IMPORT_ID;
}
- /// attribute name of referenced face
+ /// attribute name of file path
inline static const std::string& FILE_PATH_ID()
{
static const std::string MY_FILE_PATH_ID("file_path");
return MY_FILE_PATH_ID;
}
- /// default constructor
+ /// Default constructor
EXCHANGEPLUGIN_EXPORT ExchangePlugin_ImportFeature();
- /// default destructor
+ /// Default destructor
EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ImportFeature();
/// Returns the unique kind of a feature
/**
* \class ExchangePlugin_Plugin
* \ingroup Plugins
- * \brief The main class for management the import and export operations as plugin.
+ * \brief The main class for management import and export operations as plugin.
*/
class EXCHANGEPLUGIN_EXPORT ExchangePlugin_Plugin : public ModelAPI_Plugin
{
/**
* \class ExchangePlugin_Tools
- * \ingroup Plugins
- * \brief Internal tools for the plugin.
+ * \brief Internal tools for the ExchangePlugin.
*/
class EXCHANGEPLUGIN_EXPORT ExchangePlugin_Tools {
public:
std::string& theError) const;
};
+/**
+ * \class ExchangePlugin_ImportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the import format.
+ */
class ExchangePlugin_ImportFormatValidator : public ExchangePlugin_FormatValidator
{
};
+/**
+ * \class ExchangePlugin_ExportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the export format.
+ */
class ExchangePlugin_ExportFormatValidator : public ExchangePlugin_FormatValidator
{
/// Pre-execution is not needed for parameter
PARAMETERSPLUGIN_EXPORT virtual bool isPreviewNeeded() const;
- /// Creates a new part document if needed
+ /// Creates a parameter in document
PARAMETERSPLUGIN_EXPORT virtual void execute();
/// Request for initialization of data model of the feature: adding all attributes
PARAMETERSPLUGIN_EXPORT virtual void initAttributes();
- PARAMETERSPLUGIN_EXPORT virtual bool isInHistory(); //false
+ /// Reimplemented from ModelAPI_Feature::isInHistory(). Returns false.
+ PARAMETERSPLUGIN_EXPORT virtual bool isInHistory();
+ /// Reimplemented from ModelAPI_Feature::isInHistory().
PARAMETERSPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
/// Use plugin manager for features creation
protected:
/// Evaluates theExpression and returns its value.
double evaluate(const std::string& theExpression, std::string& theError);
- /// Update name of the parameter
+ /// Updates name of the parameter
void updateName();
- /// Update expression of the parameter
+ /// Updates expression of the parameter
void updateExpression();
private:
/// Returns a list of positions for theName in theExpression.
std::list<std::pair<int, int> > positions(const std::string& theExpression,
const std::string& theName);
- /// Compiles theExpression and returns a list of parameters from theExpression.
+ /// Compiles theExpression and returns a list of parameters used in theExpression.
std::list<std::string> compile(const std::string& theExpression);
- /// Extends local context with the list of parameters with values.
+ /// Extends local context with the list of parameters.
void extendLocalContext(const std::list<std::string>& theParameters);
/// Clears local context.
void clearLocalContext();
PARAMETERSPLUGIN_EXPORT ParametersPlugin_VariableValidator();
PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_VariableValidator();
- //! returns true if attribute is valid
- //! \param theAttribute the checked attribute
- //! \param theArguments arguments of the attribute
- //! \param theError the error string message if validation fails
+ /**
+ * \brief Returns true if attribute has a valid parameter name.
+ * \param theAttribute the checked attribute
+ * \param theArguments arguments of the attribute
+ * \param theError the error string message if validation fails
+ */
PARAMETERSPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
std::string& theError) const;
protected:
- /// Returns true if theString is a variable name.
+ /// Returns true if theString is a valid variable name.
PARAMETERSPLUGIN_EXPORT bool isVariable(const std::string& theString) const;
- /// Returns true if theString is unique parameter name for theAttribute context.
+ /// Returns true if theString is unique parameter name in the document of theAttribute.
PARAMETERSPLUGIN_EXPORT bool isUnique(const AttributePtr& theAttribute,
const std::string& theString) const;
};
PARAMETERSPLUGIN_EXPORT ParametersPlugin_ExpressionValidator();
PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_ExpressionValidator();
- //! returns true if attribute is valid
- //! \param theAttribute the checked attribute
- //! \param theArguments arguments of the attribute
- //! \param theError the error string message if validation fails
+ /**
+ * \brief Returns true if attribute has a valid parameter expression.
+ * \param theAttribute the checked attribute
+ * \param theArguments arguments of the attribute
+ * \param theError the error string message if validation fails
+ */
PARAMETERSPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
std::string& theError) const;
