Provides convenient interface to resource file Allows loading of the resource file and getting attributes' values 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 <DE_ConfigurationContext.hxx>

Inheritance diagram for DE_ConfigurationContext:

[legend]

Public Member Functions
	DE_ConfigurationContext ()
	Creates an empty tool.

Standard_Boolean	Load (const TCollection_AsciiString &theConfiguration)
	Import the custom configuration Save all parameters with their values.

Standard_Boolean	LoadFile (const TCollection_AsciiString &theFile)
	Import the resource file. Save all parameters with their values.

Standard_Boolean	LoadStr (const TCollection_AsciiString &theResource)
	Import the resource string. Save all parameters with their values.

Standard_Boolean	IsParamSet (const TCollection_AsciiString &theParam, const TCollection_AsciiString &theScope="") const
	Checks for existing the parameter name.

Standard_Boolean	GetReal (const TCollection_AsciiString &theParam, Standard_Real &theValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Boolean	GetInteger (const TCollection_AsciiString &theParam, Standard_Integer &theValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Boolean	GetBoolean (const TCollection_AsciiString &theParam, Standard_Boolean &theValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Boolean	GetString (const TCollection_AsciiString &theParam, TCollection_AsciiString &theValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Boolean	GetStringSeq (const TCollection_AsciiString &theParam, TColStd_ListOfAsciiString &theValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Real	RealVal (const TCollection_AsciiString &theParam, const Standard_Real theDefValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Integer	IntegerVal (const TCollection_AsciiString &theParam, const Standard_Integer theDefValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

Standard_Boolean	BooleanVal (const TCollection_AsciiString &theParam, const Standard_Boolean theDefValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

TCollection_AsciiString	StringVal (const TCollection_AsciiString &theParam, const TCollection_AsciiString &theDefValue, const TCollection_AsciiString &theScope="") const
	Gets value of parameter as being of specific type.

const DE_ResourceMap &	GetInternalMap () const
	Gets internal resource map.

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.

Protected Member Functions
Standard_Boolean	load (const TCollection_AsciiString &theResourceLine)
	Update the resource with param value from the line @paramp[in] theResourceLine line contains the parameter.

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 loading of the resource file and getting attributes' values 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

◆ DE_ConfigurationContext()

DE_ConfigurationContext::DE_ConfigurationContext ( )

Creates an empty tool.

Member Function Documentation

◆ BooleanVal()

Standard_Boolean DE_ConfigurationContext::BooleanVal	(	const TCollection_AsciiString &	theParam,
		const Standard_Boolean	theDefValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[in]	theDefValue	value by default if param is not found or has wrong type
[in]	theScope	base parameter name

Returns: specific type value

◆ GetBoolean()

Standard_Boolean DE_ConfigurationContext::GetBoolean	(	const TCollection_AsciiString &	theParam,
		Standard_Boolean &	theValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[out]	theValue	value to get by parameter
[in]	theScope	base parameter name

Returns: Standard_False if parameter is not defined or has a wrong type

◆ GetInteger()

Standard_Boolean DE_ConfigurationContext::GetInteger	(	const TCollection_AsciiString &	theParam,
		Standard_Integer &	theValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[out]	theValue	value to get by parameter
[in]	theScope	base parameter name

Returns: Standard_False if parameter is not defined or has a wrong type

◆ GetInternalMap()

const DE_ResourceMap & DE_ConfigurationContext::GetInternalMap ( ) const

inline

Gets internal resource map.

Returns: map with resource value

◆ GetReal()

Standard_Boolean DE_ConfigurationContext::GetReal	(	const TCollection_AsciiString &	theParam,
		Standard_Real &	theValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[out]	theValue	value to get by parameter
[in]	theScope	base parameter name

Returns: Standard_False if parameter is not defined or has a wrong type

◆ GetString()

Standard_Boolean DE_ConfigurationContext::GetString	(	const TCollection_AsciiString &	theParam,
		TCollection_AsciiString &	theValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[out]	theValue	value to get by parameter
[in]	theScope	base parameter name

Returns: Standard_False if parameter is not defined or has a wrong type

◆ GetStringSeq()

Standard_Boolean DE_ConfigurationContext::GetStringSeq	(	const TCollection_AsciiString &	theParam,
		TColStd_ListOfAsciiString &	theValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[out]	theValue	value to get by parameter
[in]	theScope	base parameter name

Returns: Standard_False if parameter is not defined or has a wrong type

◆ IntegerVal()

Standard_Integer DE_ConfigurationContext::IntegerVal	(	const TCollection_AsciiString &	theParam,
		const Standard_Integer	theDefValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[in]	theDefValue	value by default if param is not found or has wrong type
[in]	theScope	base parameter name

Returns: specific type value

◆ IsParamSet()

Standard_Boolean DE_ConfigurationContext::IsParamSet	(	const TCollection_AsciiString &	theParam,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Checks for existing the parameter name.

Parameters

[in]	theParam	complex parameter name
[in]	theScope	base parameter name

Returns: Standard_True if parameter is defined in the resource file

◆ Load()

Standard_Boolean DE_ConfigurationContext::Load ( const TCollection_AsciiString & theConfiguration )

Import the custom configuration Save all parameters with their values.

Parameters

[in] theConfiguration path to configuration file or string value

Returns: true in case of success, false otherwise

◆ load()

Standard_Boolean DE_ConfigurationContext::load ( const TCollection_AsciiString & theResourceLine )

protected

Update the resource with param value from the line @paramp[in] theResourceLine line contains the parameter.

Returns: true if theResourceLine has loaded correctly

◆ LoadFile()

Standard_Boolean DE_ConfigurationContext::LoadFile ( const TCollection_AsciiString & theFile )

Import the resource file. Save all parameters with their values.

Parameters

[in] theFile path to the resource file

Returns: true in case of success, false otherwise

◆ LoadStr()

Standard_Boolean DE_ConfigurationContext::LoadStr ( const TCollection_AsciiString & theResource )

Import the resource string. Save all parameters with their values.

Parameters

[in] theResource string with resource content

Returns: true in case of success, false otherwise

◆ RealVal()

Standard_Real DE_ConfigurationContext::RealVal	(	const TCollection_AsciiString &	theParam,
		const Standard_Real	theDefValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[in]	theDefValue	value by default if param is not found or has wrong type
[in]	theScope	base parameter name

Returns: specific type value

◆ StringVal()

TCollection_AsciiString DE_ConfigurationContext::StringVal	(	const TCollection_AsciiString &	theParam,
		const TCollection_AsciiString &	theDefValue,
		const TCollection_AsciiString &	theScope = `""`
	)		const

Gets value of parameter as being of specific type.

Parameters

[in]	theParam	complex parameter name
[in]	theDefValue	value by default if param is not found or has wrong type
[in]	theScope	base parameter name

Returns: specific type value

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

DE_ConfigurationContext.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DE_ConfigurationContext()

Member Function Documentation

◆ BooleanVal()

◆ GetBoolean()

◆ GetInteger()

◆ GetInternalMap()

◆ GetReal()

◆ GetString()

◆ GetStringSeq()

◆ IntegerVal()

◆ IsParamSet()

◆ Load()

◆ load()

◆ LoadFile()

◆ LoadStr()

◆ RealVal()

◆ StringVal()