Open CASCADE Technology  7.4.1.dev
Public Member Functions | Static Public Member Functions
Resource_Manager Class Reference

Defines a resource structure and its management methods. More...

#include <Resource_Manager.hxx>

Inheritance diagram for Resource_Manager:
Inheritance graph
[legend]

Public Member Functions

 Resource_Manager (const Standard_CString aName, const Standard_Boolean Verbose=Standard_False)
 Create a Resource manager. Attempts to find the two following files: $CSF_aNameDefaults/aName $CSF_aNameUserDefaults/aName and load them respectively into a reference and a user resource structure. More...
 
 Resource_Manager (const Standard_CString aName, TCollection_AsciiString &aDefaultsDirectory, TCollection_AsciiString &anUserDefaultsDirectory, const Standard_Boolean Verbose=Standard_False)
 
Standard_Boolean Save () const
 Save the user resource structure in the specified file. Creates the file if it does not exist. More...
 
Standard_Boolean Find (const Standard_CString aResource) const
 returns True if the Resource does exist. More...
 
virtual Standard_Integer Integer (const Standard_CString aResourceName) const
 Gets the value of an integer resource according to its instance and its type. More...
 
virtual Standard_Real Real (const Standard_CString aResourceName) const
 Gets the value of a real resource according to its instance and its type. More...
 
virtual Standard_CString Value (const Standard_CString aResourceName) const
 Gets the value of a CString resource according to its instance and its type. More...
 
virtual Standard_ExtString ExtValue (const Standard_CString aResourceName)
 Gets the value of an ExtString resource according to its instance and its type. More...
 
virtual void SetResource (const Standard_CString aResourceName, const Standard_Integer aValue)
 Sets the new value of an integer resource. If the resource does not exist, it is created. More...
 
virtual void SetResource (const Standard_CString aResourceName, const Standard_Real aValue)
 Sets the new value of a real resource. If the resource does not exist, it is created. More...
 
virtual void SetResource (const Standard_CString aResourceName, const Standard_CString aValue)
 Sets the new value of an CString resource. If the resource does not exist, it is created. More...
 
virtual void SetResource (const Standard_CString aResourceName, const Standard_ExtString aValue)
 Sets the new value of an ExtString resource. If the resource does not exist, it is created. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 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. 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...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static void GetResourcePath (TCollection_AsciiString &aPath, const Standard_CString aName, const Standard_Boolean isUserDefaults)
 Gets the resource file full path by its name. If corresponding environment variable is not set or file doesn't exist returns empty string. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

Defines a resource structure and its management methods.

Constructor & Destructor Documentation

◆ Resource_Manager() [1/2]

Resource_Manager::Resource_Manager ( const Standard_CString  aName,
const Standard_Boolean  Verbose = Standard_False 
)

Create a Resource manager. Attempts to find the two following files: $CSF_aNameDefaults/aName $CSF_aNameUserDefaults/aName and load them respectively into a reference and a user resource structure.

If CSF_ResourceVerbose defined, seeked files will be printed.

FILE SYNTAX The syntax of a resource file is a sequence of resource lines terminated by newline characters or end of file. The syntax of an individual resource line is:

◆ Resource_Manager() [2/2]

Resource_Manager::Resource_Manager ( const Standard_CString  aName,
TCollection_AsciiString aDefaultsDirectory,
TCollection_AsciiString anUserDefaultsDirectory,
const Standard_Boolean  Verbose = Standard_False 
)

Member Function Documentation

◆ ExtValue()

virtual Standard_ExtString Resource_Manager::ExtValue ( const Standard_CString  aResourceName)
virtual

Gets the value of an ExtString resource according to its instance and its type.

◆ Find()

Standard_Boolean Resource_Manager::Find ( const Standard_CString  aResource) const

returns True if the Resource does exist.

◆ GetResourcePath()

static void Resource_Manager::GetResourcePath ( TCollection_AsciiString aPath,
const Standard_CString  aName,
const Standard_Boolean  isUserDefaults 
)
static

Gets the resource file full path by its name. If corresponding environment variable is not set or file doesn't exist returns empty string.

◆ Integer()

virtual Standard_Integer Resource_Manager::Integer ( const Standard_CString  aResourceName) const
virtual

Gets the value of an integer resource according to its instance and its type.

◆ Real()

virtual Standard_Real Resource_Manager::Real ( const Standard_CString  aResourceName) const
virtual

Gets the value of a real resource according to its instance and its type.

◆ Save()

Standard_Boolean Resource_Manager::Save ( ) const

Save the user resource structure in the specified file. Creates the file if it does not exist.

◆ SetResource() [1/4]

virtual void Resource_Manager::SetResource ( const Standard_CString  aResourceName,
const Standard_Integer  aValue 
)
virtual

Sets the new value of an integer resource. If the resource does not exist, it is created.

◆ SetResource() [2/4]

virtual void Resource_Manager::SetResource ( const Standard_CString  aResourceName,
const Standard_Real  aValue 
)
virtual

Sets the new value of a real resource. If the resource does not exist, it is created.

◆ SetResource() [3/4]

virtual void Resource_Manager::SetResource ( const Standard_CString  aResourceName,
const Standard_CString  aValue 
)
virtual

Sets the new value of an CString resource. If the resource does not exist, it is created.

◆ SetResource() [4/4]

virtual void Resource_Manager::SetResource ( const Standard_CString  aResourceName,
const Standard_ExtString  aValue 
)
virtual

Sets the new value of an ExtString resource. If the resource does not exist, it is created.

◆ Value()

virtual Standard_CString Resource_Manager::Value ( const Standard_CString  aResourceName) const
virtual

Gets the value of a CString resource according to its instance and its type.


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