Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions
Dynamic_MethodDefinitionsDictionary Class Reference

This class groups in a dictionary of all the
various definitions of methods. It also allows the
share of the same definition by more than one
MethodInstance to preserve a global coherence and
also to manage the memory. To use this class an
inheritance is necessary with perhaps the overload
of the Switch method if the parameter types are
not of the type BooleanParameter,
IntegerParameter, RealParameter and
StringParameter.
More...

#include <Dynamic_MethodDefinitionsDictionary.hxx>

Inheritance diagram for Dynamic_MethodDefinitionsDictionary:
Inheritance graph
[legend]

Public Member Functions

void Creates (const Standard_CString afilename)
 Starting with a file named <afilename>, fills the
dictionary with all the wishes definitions.
More...
 
Standard_Boolean Definition (const Handle< Dynamic_Method > &adefinition)
 This method sets the new definition <adefinition> in
the dictionary. It returns true if the operation is
successful, false otherwise.
More...
 
Handle_Dynamic_Parameter Switch (const Standard_CString aname, const Standard_CString atype, const Standard_CString avalue) const
 This virtual method allows the user to add recognition
of its own parameters when reading the file to fill
the dictionary.
More...
 
Standard_Boolean Definition (const Standard_CString atype, Handle< Dynamic_Method > &adefinition) const
 Returns from the dictionary in the out variable
<adefinition> a reference to the right instance of the
definition identified by its type <atype>. The method
returns true if the definition exist, false otherwise.
More...
 
Standard_Boolean UpToDate () const
 Returns true if there has been no modification of the
file method-definitions.dat since the creation of the
dictionary object, false otherwise.
More...
 
Standard_Integer NumberOfDefinitions () const
 Returns the number of definitions stored in the
dictionary.
More...
 
Handle_Dynamic_Method Definition (const Standard_Integer anindex) const
 Returns a reference on the definition identified by
the index <anidex>.
More...
 
void Dump (Standard_OStream &astream) const
 Useful for debugging.
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 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...
 

Protected Member Functions

 Dynamic_MethodDefinitionsDictionary ()
 Deferred constructor of the class.
More...
 

Detailed Description

This class groups in a dictionary of all the
various definitions of methods. It also allows the
share of the same definition by more than one
MethodInstance to preserve a global coherence and
also to manage the memory. To use this class an
inheritance is necessary with perhaps the overload
of the Switch method if the parameter types are
not of the type BooleanParameter,
IntegerParameter, RealParameter and
StringParameter.

Constructor & Destructor Documentation

Dynamic_MethodDefinitionsDictionary::Dynamic_MethodDefinitionsDictionary ( )
protected

Deferred constructor of the class.

Member Function Documentation

void Dynamic_MethodDefinitionsDictionary::Creates ( const Standard_CString  afilename)

Starting with a file named <afilename>, fills the
dictionary with all the wishes definitions.

Standard_Boolean Dynamic_MethodDefinitionsDictionary::Definition ( const Handle< Dynamic_Method > &  adefinition)

This method sets the new definition <adefinition> in
the dictionary. It returns true if the operation is
successful, false otherwise.

Standard_Boolean Dynamic_MethodDefinitionsDictionary::Definition ( const Standard_CString  atype,
Handle< Dynamic_Method > &  adefinition 
) const

Returns from the dictionary in the out variable
<adefinition> a reference to the right instance of the
definition identified by its type <atype>. The method
returns true if the definition exist, false otherwise.

Handle_Dynamic_Method Dynamic_MethodDefinitionsDictionary::Definition ( const Standard_Integer  anindex) const

Returns a reference on the definition identified by
the index <anidex>.

void Dynamic_MethodDefinitionsDictionary::Dump ( Standard_OStream astream) const

Useful for debugging.

Standard_Integer Dynamic_MethodDefinitionsDictionary::NumberOfDefinitions ( ) const

Returns the number of definitions stored in the
dictionary.

Handle_Dynamic_Parameter Dynamic_MethodDefinitionsDictionary::Switch ( const Standard_CString  aname,
const Standard_CString  atype,
const Standard_CString  avalue 
) const

This virtual method allows the user to add recognition
of its own parameters when reading the file to fill
the dictionary.

Standard_Boolean Dynamic_MethodDefinitionsDictionary::UpToDate ( ) const

Returns true if there has been no modification of the
file method-definitions.dat since the creation of the
dictionary object, false otherwise.


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