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:

Public Member Functions
	ShapeProcess_Context ()
	Creates an empty tool
	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_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
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
const Handle_Resource_Manager &	ResourceManager () const
	Returns internal Resource_Manager object
void	SetScope (const Standard_CString scope)
	Set a new (sub)scope
void	UnSetScope ()
	Go out of current scope
Standard_Boolean	IsParamSet (const Standard_CString param) const
	Returns True if parameter is defined in the resource file
Standard_Boolean	GetReal (const Standard_CString param, Standard_Real &val) const
Standard_Boolean	GetInteger (const Standard_CString param, Standard_Integer &val) const
Standard_Boolean	GetBoolean (const Standard_CString param, Standard_Boolean &val) const
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_Real	RealVal (const Standard_CString param, const Standard_Real def) const
Standard_Integer	IntegerVal (const Standard_CString param, const Standard_Integer def) const
Standard_Boolean	BooleanVal (const Standard_CString param, const Standard_Boolean def) const
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
void	SetMessenger (const Handle< Message_Messenger > &messenger)
	Sets Messenger used for outputting messages.
Handle_Message_Messenger	Messenger () const
	Returns Messenger used for outputting messages.
void	SetProgress (const Handle< Message_ProgressIndicator > &theProgress)
	Sets Progress Indicator.
Handle_Message_ProgressIndicator	Progress () const
	Returns Progress Indicator.
void	SetTraceLevel (const Standard_Integer tracelev)
	Sets trace level used for outputting messages
Standard_Integer	TraceLevel () const
	Returns trace level used for outputting messages.

---

Constructor & Destructor Documentation

ShapeProcess_Context::ShapeProcess_Context

(

)

ShapeProcess_Context::ShapeProcess_Context	(	const Standard_CString	file,
		const Standard_CString	scope = ""
	)

---

Member Function Documentation

Standard_Boolean ShapeProcess_Context::BooleanVal	(	const Standard_CString	param,
		const Standard_Boolean	def
	)		const

Standard_Boolean ShapeProcess_Context::GetBoolean	(	const Standard_CString	param,
		Standard_Boolean &	val
	)		const

Standard_Boolean ShapeProcess_Context::GetInteger	(	const Standard_CString	param,
		Standard_Integer &	val
	)		const

Standard_Boolean ShapeProcess_Context::GetReal	(	const Standard_CString	param,
		Standard_Real &	val
	)		const

Standard_Boolean ShapeProcess_Context::GetString	(	const Standard_CString	param,
		TCollection_AsciiString &	val
	)		const

Standard_Boolean ShapeProcess_Context::Init	(	const Standard_CString	file,
		const Standard_CString	scope = ""
	)

Standard_Integer ShapeProcess_Context::IntegerVal	(	const Standard_CString	param,
		const Standard_Integer	def
	)		const

Standard_Boolean ShapeProcess_Context::IsParamSet

(

const Standard_CString

param

)

const

Handle_Resource_Manager ShapeProcess_Context::LoadResourceManager

(

const Standard_CString

file

)

Handle_Message_Messenger ShapeProcess_Context::Messenger

(

)

const

Handle_Message_ProgressIndicator ShapeProcess_Context::Progress

(

)

const

Standard_Real ShapeProcess_Context::RealVal	(	const Standard_CString	param,
		const Standard_Real	def
	)		const

const Handle_Resource_Manager& ShapeProcess_Context::ResourceManager

(

)

const

void ShapeProcess_Context::SetMessenger

(

const Handle< Message_Messenger > &

messenger

)

void ShapeProcess_Context::SetProgress

(

const Handle< Message_ProgressIndicator > &

theProgress

)

void ShapeProcess_Context::SetScope

(

const Standard_CString

scope

)

void ShapeProcess_Context::SetTraceLevel

(

const Standard_Integer

tracelev

)

• 0: no trace at all
  
• 1: errors
  
• 2: errors and warnings
  
• 3: all messages
  Default is 1 : Errors traced
  

Standard_CString ShapeProcess_Context::StringVal	(	const Standard_CString	param,
		const Standard_CString	def
	)		const

Standard_Integer ShapeProcess_Context::TraceLevel

(

)

const

void ShapeProcess_Context::UnSetScope

(

)

---

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

• ShapeProcess_Context.hxx