mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-06 18:26:22 +03:00
141 lines
4.8 KiB
C++
141 lines
4.8 KiB
C++
// Created on: 2000-08-21
|
|
// Created by: Andrey BETENEV
|
|
// Copyright (c) 2000-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _ShapeProcess_Context_HeaderFile
|
|
#define _ShapeProcess_Context_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_Type.hxx>
|
|
|
|
#include <TColStd_HSequenceOfHAsciiString.hxx>
|
|
#include <Standard_Integer.hxx>
|
|
#include <Standard_Transient.hxx>
|
|
class Resource_Manager;
|
|
class Message_Messenger;
|
|
class TCollection_AsciiString;
|
|
|
|
|
|
class ShapeProcess_Context;
|
|
DEFINE_STANDARD_HANDLE(ShapeProcess_Context, Standard_Transient)
|
|
|
|
//! Provides convenient interface to resource file
|
|
//! Allows to load resource file and get values of
|
|
//! attributes starting from some scope, for example
|
|
//! if scope is defined as "ToV4" and requested parameter
|
|
//! is "exec.op", value of "ToV4.exec.op" parameter from
|
|
//! the resource file will be returned
|
|
class ShapeProcess_Context : public Standard_Transient
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
//! Creates an empty tool
|
|
Standard_EXPORT ShapeProcess_Context();
|
|
|
|
//! Creates a new tool and initialises by name of
|
|
//! resource file and (if specified) starting scope
|
|
//! Calls method Init()
|
|
Standard_EXPORT ShapeProcess_Context(const Standard_CString file, const Standard_CString scope = "");
|
|
|
|
//! Initialises a tool by loading resource file and
|
|
//! (if specified) sets starting scope
|
|
//! Returns False if resource file not found
|
|
Standard_EXPORT Standard_Boolean Init (const Standard_CString file, const Standard_CString scope = "");
|
|
|
|
//! Loading Resource_Manager object if this object not
|
|
//! equal internal static Resource_Manager object or
|
|
//! internal static Resource_Manager object is null
|
|
Standard_EXPORT Handle(Resource_Manager) LoadResourceManager (const Standard_CString file);
|
|
|
|
//! Returns internal Resource_Manager object
|
|
Standard_EXPORT const Handle(Resource_Manager)& ResourceManager() const;
|
|
|
|
//! Set a new (sub)scope
|
|
Standard_EXPORT void SetScope (const Standard_CString scope);
|
|
|
|
//! Go out of current scope
|
|
Standard_EXPORT void UnSetScope();
|
|
|
|
//! Returns True if parameter is defined in the resource file
|
|
Standard_EXPORT Standard_Boolean IsParamSet (const Standard_CString param) const;
|
|
|
|
Standard_EXPORT Standard_Boolean GetReal (const Standard_CString param, Standard_Real& val) const;
|
|
|
|
Standard_EXPORT Standard_Boolean GetInteger (const Standard_CString param, Standard_Integer& val) const;
|
|
|
|
Standard_EXPORT Standard_Boolean GetBoolean (const Standard_CString param, Standard_Boolean& val) const;
|
|
|
|
//! Get value of parameter as being of specific type
|
|
//! Returns False if parameter is not defined or has a wrong type
|
|
Standard_EXPORT Standard_Boolean GetString (const Standard_CString param, TCollection_AsciiString& val) const;
|
|
|
|
Standard_EXPORT Standard_Real RealVal (const Standard_CString param, const Standard_Real def) const;
|
|
|
|
Standard_EXPORT Standard_Integer IntegerVal (const Standard_CString param, const Standard_Integer def) const;
|
|
|
|
Standard_EXPORT Standard_Boolean BooleanVal (const Standard_CString param, const Standard_Boolean def) const;
|
|
|
|
//! Get value of parameter as being of specific type
|
|
//! If parameter is not defined or does not have expected
|
|
//! type, returns default value as specified
|
|
Standard_EXPORT Standard_CString StringVal (const Standard_CString param, const Standard_CString def) const;
|
|
|
|
//! Sets Messenger used for outputting messages.
|
|
Standard_EXPORT void SetMessenger (const Handle(Message_Messenger)& messenger);
|
|
|
|
//! Returns Messenger used for outputting messages.
|
|
Standard_EXPORT Handle(Message_Messenger) Messenger() const;
|
|
|
|
//! Sets trace level used for outputting messages
|
|
//! - 0: no trace at all
|
|
//! - 1: errors
|
|
//! - 2: errors and warnings
|
|
//! - 3: all messages
|
|
//! Default is 1 : Errors traced
|
|
Standard_EXPORT void SetTraceLevel (const Standard_Integer tracelev);
|
|
|
|
//! Returns trace level used for outputting messages.
|
|
Standard_EXPORT Standard_Integer TraceLevel() const;
|
|
|
|
|
|
|
|
|
|
DEFINE_STANDARD_RTTIEXT(ShapeProcess_Context,Standard_Transient)
|
|
|
|
protected:
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
Handle(Resource_Manager) myRC;
|
|
Handle(TColStd_HSequenceOfHAsciiString) myScope;
|
|
Handle(Message_Messenger) myMessenger;
|
|
Standard_Integer myTraceLev;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _ShapeProcess_Context_HeaderFile
|