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. More...

#include <ShapeProcess_Context.hxx>

Inheritance diagram for ShapeProcess_Context:

[legend]

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	SetTraceLevel (const Standard_Integer tracelev)
	Sets trace level used for outputting messages.

Standard_Integer	TraceLevel () const
	Returns trace level used for outputting messages.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

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.

Constructor & Destructor Documentation

◆ ShapeProcess_Context() [1/2]

ShapeProcess_Context::ShapeProcess_Context ( )

Creates an empty tool.

◆ ShapeProcess_Context() [2/2]

ShapeProcess_Context::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()

Member Function Documentation

◆ BooleanVal()

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

◆ GetBoolean()

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

◆ GetInteger()

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

◆ GetReal()

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

◆ GetString()

Standard_Boolean ShapeProcess_Context::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.

◆ Init()

Standard_Boolean ShapeProcess_Context::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.

◆ IntegerVal()

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

◆ IsParamSet()

Standard_Boolean ShapeProcess_Context::IsParamSet ( const Standard_CString param ) const

Returns True if parameter is defined in the resource file.

◆ LoadResourceManager()

Handle< Resource_Manager > ShapeProcess_Context::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.

◆ Messenger()

Handle< Message_Messenger > ShapeProcess_Context::Messenger ( ) const

Returns Messenger used for outputting messages.

◆ RealVal()

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

◆ ResourceManager()

const Handle< Resource_Manager > & ShapeProcess_Context::ResourceManager ( ) const

Returns internal Resource_Manager object.

◆ SetMessenger()

void ShapeProcess_Context::SetMessenger ( const Handle< Message_Messenger > & messenger )

Sets Messenger used for outputting messages.

◆ SetScope()

void ShapeProcess_Context::SetScope ( const Standard_CString scope )

Set a new (sub)scope.

◆ SetTraceLevel()

void ShapeProcess_Context::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

◆ StringVal()

Standard_CString ShapeProcess_Context::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.

◆ TraceLevel()

Standard_Integer ShapeProcess_Context::TraceLevel ( ) const

Returns trace level used for outputting messages.

◆ UnSetScope()

void ShapeProcess_Context::UnSetScope ( )

Go out of current scope.

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

ShapeProcess_Context.hxx

Public Member Functions

Additional Inherited Members