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 char const file, const char const scope="")
	Creates a new tool and initialises by name of resource file and (if specified) starting scope Calls method Init().
bool	Init (const char const file, const char const scope="")
	Initialises a tool by loading resource file and (if specified) sets starting scope Returns False if resource file not found.
occ::handle< Resource_Manager >	LoadResourceManager (const char *const file)
	Loading Resource_Manager object if this object not equal internal static Resource_Manager object or internal static Resource_Manager object is null.
const occ::handle< Resource_Manager > &	ResourceManager () const
	Returns internal Resource_Manager object.
void	SetScope (const char *const scope)
	Set a new (sub)scope.
void	UnSetScope ()
	Go out of current scope.
bool	IsParamSet (const char *const paramparam) const
	Returns True if parameter is defined in the resource file.
bool	GetReal (const char *const paramparam, double &valval) const
bool	GetInteger (const char *const paramparam, int &valval) const
bool	GetBoolean (const char *const paramparam, bool &valval) const
bool	GetString (const char *const paramparam, TCollection_AsciiString &valval) const
	Get value of parameter as being of specific type Returns False if parameter is not defined or has a wrong type.
double	RealVal (const char *const paramparam, const double def) const
int	IntegerVal (const char *const paramparam, const int def) const
bool	BooleanVal (const char *const paramparam, const bool def) const
const char *	StringVal (const char const paramparam, const char const 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 occ::handle< Message_Messenger > &messenger)
	Sets Messenger used for outputting messages.
occ::handle< Message_Messenger >	Messenger () const
	Returns Messenger used for outputting messages.
void	SetTraceLevel (const int tracelev)
	Sets trace level used for outputting messages.
int	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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 char *const	file,
		const char *const	scope = "" )

Creates a new tool and initialises by name of resource file and (if specified) starting scope Calls method Init().

Member Function Documentation

◆ BooleanVal()

bool ShapeProcess_Context::BooleanVal	(	const char *const	param,
		const bool	def ) const

◆ GetBoolean()

bool ShapeProcess_Context::GetBoolean	(	const char *const	param,
		bool &	val ) const

◆ GetInteger()

bool ShapeProcess_Context::GetInteger	(	const char *const	param,
		int &	val ) const

◆ GetReal()

bool ShapeProcess_Context::GetReal	(	const char *const	param,
		double &	val ) const

◆ GetString()

bool ShapeProcess_Context::GetString	(	const char *const	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()

bool ShapeProcess_Context::Init	(	const char *const	file,
		const char *const	scope = "" )

Initialises a tool by loading resource file and (if specified) sets starting scope Returns False if resource file not found.

◆ IntegerVal()

int ShapeProcess_Context::IntegerVal	(	const char *const	param,
		const int	def ) const

◆ IsParamSet()

bool ShapeProcess_Context::IsParamSet ( const char *const param ) const

Returns True if parameter is defined in the resource file.

◆ LoadResourceManager()

occ::handle< Resource_Manager > ShapeProcess_Context::LoadResourceManager ( const char *const file )

Loading Resource_Manager object if this object not equal internal static Resource_Manager object or internal static Resource_Manager object is null.

◆ Messenger()

occ::handle< Message_Messenger > ShapeProcess_Context::Messenger ( ) const

Returns Messenger used for outputting messages.

◆ RealVal()

double ShapeProcess_Context::RealVal	(	const char *const	param,
		const double	def ) const

◆ ResourceManager()

const occ::handle< Resource_Manager > & ShapeProcess_Context::ResourceManager ( ) const

Returns internal Resource_Manager object.

◆ SetMessenger()

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

Sets Messenger used for outputting messages.

◆ SetScope()

void ShapeProcess_Context::SetScope ( const char *const scope )

Set a new (sub)scope.

◆ SetTraceLevel()

void ShapeProcess_Context::SetTraceLevel ( const int 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()

const char * ShapeProcess_Context::StringVal	(	const char *const	param,
		const char *const	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()

int 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