|
Open CASCADE Technology
6.7.1
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
Open CASCADE Technology
6.7.1
|
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>
Public Member Functions | |
| ShapeProcess_Context () | |
| Creates an empty tool More... | |
| 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() More... | |
| 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 More... | |
| 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 More... | |
| const Handle_Resource_Manager & | ResourceManager () const |
| Returns internal Resource_Manager object More... | |
| void | SetScope (const Standard_CString scope) |
| Set a new (sub)scope More... | |
| void | UnSetScope () |
| Go out of current scope More... | |
| Standard_Boolean | IsParamSet (const Standard_CString param) const |
| Returns True if parameter is defined in the resource file More... | |
| 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 More... | |
| 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 More... | |
| void | SetMessenger (const Handle< Message_Messenger > &messenger) |
| Sets Messenger used for outputting messages. More... | |
| Handle_Message_Messenger | Messenger () const |
| Returns Messenger used for outputting messages. More... | |
| void | SetProgress (const Handle< Message_ProgressIndicator > &theProgress) |
| Sets Progress Indicator. More... | |
| Handle_Message_ProgressIndicator | Progress () const |
| Returns Progress Indicator. More... | |
| void | SetTraceLevel (const Standard_Integer tracelev) |
| Sets trace level used for outputting messages More... | |
| Standard_Integer | TraceLevel () const |
| Returns trace level used for outputting messages. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | ShallowDump (Standard_OStream &) const |
| virtual const Handle_Standard_Type & | DynamicType () const |
| Returns a type information object about this object. More... | |
| Standard_Boolean | IsInstance (const Handle_Standard_Type &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const 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. More... | |
| 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. More... | |
| virtual Handle_Standard_Transient | This () const |
| Returns a Handle which references this object. Must never be called to objects created in stack. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
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
| ShapeProcess_Context::ShapeProcess_Context | ( | ) |
Creates an empty tool
| 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()
| 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 |
Get value of parameter as being of specific type
Returns False if parameter is not defined or has a wrong type
| 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
| Standard_Integer ShapeProcess_Context::IntegerVal | ( | const Standard_CString | param, |
| const Standard_Integer | def | ||
| ) | const |
| Standard_Boolean ShapeProcess_Context::IsParamSet | ( | const Standard_CString | param | ) | const |
Returns True if parameter is defined in the resource file
| 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
| Handle_Message_Messenger ShapeProcess_Context::Messenger | ( | ) | const |
Returns Messenger used for outputting messages.
| Handle_Message_ProgressIndicator ShapeProcess_Context::Progress | ( | ) | const |
Returns Progress Indicator.
| Standard_Real ShapeProcess_Context::RealVal | ( | const Standard_CString | param, |
| const Standard_Real | def | ||
| ) | const |
| const Handle_Resource_Manager& ShapeProcess_Context::ResourceManager | ( | ) | const |
Returns internal Resource_Manager object
| void ShapeProcess_Context::SetMessenger | ( | const Handle< Message_Messenger > & | messenger | ) |
Sets Messenger used for outputting messages.
| void ShapeProcess_Context::SetProgress | ( | const Handle< Message_ProgressIndicator > & | theProgress | ) |
Sets Progress Indicator.
| void ShapeProcess_Context::SetScope | ( | const Standard_CString | scope | ) |
Set a new (sub)scope
| void ShapeProcess_Context::SetTraceLevel | ( | const Standard_Integer | tracelev | ) |
Sets trace level used for outputting messages
| 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
| Standard_Integer ShapeProcess_Context::TraceLevel | ( | ) | const |
Returns trace level used for outputting messages.
| void ShapeProcess_Context::UnSetScope | ( | ) |
Go out of current scope
1.8.5