OCC Main Page | ModelingAlgorithms | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingAlgorithms
TKShHealing
ShapeProcess


ShapeProcess_Context Class Reference

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
.

#include <ShapeProcess_Context.hxx>

Inheritance diagram for ShapeProcess_Context:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT ShapeProcess_Context ()
 Creates an empty tool
.
Standard_EXPORT ShapeProcess_Context (const Standard_CString file, const Standard_CString scope="")
 Creates a new tool and initialises by name of
resource file and (if specified) starting scope
Calls method Init()
.
Standard_EXPORT Standard_Boolean Init (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 Handle_Resource_Manager LoadResourceManager (const Standard_CString file)
 Loading Resource_Manager object if this object not
equal internal static Resource_Manager object or
internal static Resource_Manager object is null
.
Standard_EXPORT const Handle_Resource_Manager & ResourceManager () const
 Returns internal Resource_Manager object
.
Standard_EXPORT void SetScope (const Standard_CString scope)
 Set a new (sub)scope
.
Standard_EXPORT void UnSetScope ()
 Go out of current scope
.
Standard_EXPORT Standard_Boolean IsParamSet (const Standard_CString param) const
 Returns True if parameter is defined in the resource file
.
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
Standard_EXPORT Standard_Boolean GetString (const Standard_CString param, TCollection_AsciiString &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_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
Standard_EXPORT Standard_CString StringVal (const Standard_CString param, const Standard_CString 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 void SetMessenger (const Handle(Message_Messenger)&messenger)
 Sets Messenger used for outputting messages.
.
Standard_EXPORT Handle_Message_Messenger Messenger () const
 Returns Messenger used for outputting messages.
.
Standard_EXPORT void SetTraceLevel (const Standard_Integer tracelev)
 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 Standard_Integer TraceLevel () const
 Returns trace level used for outputting messages.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Handle_Resource_Manager myRC
Handle_TColStd_HSequenceOfHAsciiString myScope
Handle_Message_Messenger myMessenger
Standard_Integer myTraceLev

Constructor & Destructor Documentation

Standard_EXPORT ShapeProcess_Context::ShapeProcess_Context  ) 
 

Standard_EXPORT ShapeProcess_Context::ShapeProcess_Context const Standard_CString  file,
const Standard_CString  scope = ""
 


Member Function Documentation

Standard_EXPORT Standard_Boolean ShapeProcess_Context::BooleanVal const Standard_CString  param,
const Standard_Boolean  def
const
 

Standard_EXPORT Standard_Boolean ShapeProcess_Context::GetBoolean const Standard_CString  param,
Standard_Boolean val
const
 

Standard_EXPORT Standard_Boolean ShapeProcess_Context::GetInteger const Standard_CString  param,
Standard_Integer &  val
const
 

Standard_EXPORT Standard_Boolean ShapeProcess_Context::GetReal const Standard_CString  param,
Standard_Real &  val
const
 

Standard_EXPORT Standard_Boolean ShapeProcess_Context::GetString const Standard_CString  param,
TCollection_AsciiString &  val
const
 

Standard_EXPORT const ShapeProcess_Context::Handle Standard_Type   )  const
 

Reimplemented in ShapeProcess_ShapeContext.

Standard_EXPORT Standard_Boolean ShapeProcess_Context::Init const Standard_CString  file,
const Standard_CString  scope = ""
 

Standard_EXPORT Standard_Integer ShapeProcess_Context::IntegerVal const Standard_CString  param,
const Standard_Integer  def
const
 

Standard_EXPORT Standard_Boolean ShapeProcess_Context::IsParamSet const Standard_CString  param  )  const
 

Standard_EXPORT Handle_Resource_Manager ShapeProcess_Context::LoadResourceManager const Standard_CString  file  ) 
 

Standard_EXPORT Handle_Message_Messenger ShapeProcess_Context::Messenger  )  const
 

Standard_EXPORT Standard_Real ShapeProcess_Context::RealVal const Standard_CString  param,
const Standard_Real  def
const
 

Standard_EXPORT const Handle_Resource_Manager& ShapeProcess_Context::ResourceManager  )  const
 

Standard_EXPORT void ShapeProcess_Context::SetMessenger const Handle(Message_Messenger)&  messenger  ) 
 

Standard_EXPORT void ShapeProcess_Context::SetScope const Standard_CString  scope  ) 
 

Standard_EXPORT void ShapeProcess_Context::SetTraceLevel const Standard_Integer  tracelev  ) 
 

Standard_EXPORT Standard_CString ShapeProcess_Context::StringVal const Standard_CString  param,
const Standard_CString  def
const
 

Standard_EXPORT Standard_Integer ShapeProcess_Context::TraceLevel  )  const
 

Standard_EXPORT void ShapeProcess_Context::UnSetScope  ) 
 


Field Documentation

Handle_Message_Messenger ShapeProcess_Context::myMessenger [private]
 

Handle_Resource_Manager ShapeProcess_Context::myRC [private]
 

Handle_TColStd_HSequenceOfHAsciiString ShapeProcess_Context::myScope [private]
 

Standard_Integer ShapeProcess_Context::myTraceLev [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:42:41 2008 for OpenCASCADE by  doxygen 1.4.1