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

#include <Resource_Manager.hxx>

Inheritance diagram for Resource_Manager:

Public Member Functions
	Resource_Manager (const Standard_CString aName, const Standard_Boolean Verbose=Standard_False)
	Create a Resource manager. <br> Attempts to find the two following files: <br> $CSF_`aName`Defaults/aName <br> $CSF_`aName`UserDefaults/aName <br> and load them respectively into a reference and a user resource structure. <br> 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: 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 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...

Detailed Description

Defines a resource structure and its management methods.

Constructor & Destructor Documentation

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

 Create a Resource manager. <br>
     Attempts to find the two following files: <br>
     $CSF_`aName`Defaults/aName <br>
     $CSF_`aName`UserDefaults/aName <br>
     and load them respectively into a reference and a user resource structure. <br>

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::Resource_Manager	(	const Standard_CString	aName,
		TCollection_AsciiString &	aDefaultsDirectory,
		TCollection_AsciiString &	anUserDefaultsDirectory,
		const Standard_Boolean	Verbose = `Standard_False`
	)

Member Function Documentation

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.

Standard_Boolean Resource_Manager::Find ( const Standard_CString aResource ) const

returns True if the Resource does exist.

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.

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.

Standard_Boolean Resource_Manager::Save ( ) const

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

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.

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.

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.

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.

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:

Resource_Manager.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation