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_Parameter Class Reference

A parameter is defined as the association of a
name and a value. For easy use, inherited classes
have been created to manipulate values by their
C++ type. This class is the root class of all the
derived parameter classes. Only the identifier of
the parameter is stored in it. The associated
value is stored in the inherited classes where it
is more easy to overload the methods manipulating
the value. No instance of this class must be
created. It is for this reason that this class is
deferred.
More...

#include <Dynamic_Parameter.hxx>

Inheritance diagram for Dynamic_Parameter:
Inheritance graph
[legend]

Public Member Functions

TCollection_AsciiString Name () const
 Returns in an AsciiString the name of the parameter.
More...
 
virtual void Dump (Standard_OStream &astream) const
 Useful for debugging.
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_Transientoperator= (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...
 

Protected Member Functions

 Dynamic_Parameter (const Standard_CString aname)
 Initializer of this class taking in argument the name
of the parameter <aname>.
More...
 

Detailed Description

A parameter is defined as the association of a
name and a value. For easy use, inherited classes
have been created to manipulate values by their
C++ type. This class is the root class of all the
derived parameter classes. Only the identifier of
the parameter is stored in it. The associated
value is stored in the inherited classes where it
is more easy to overload the methods manipulating
the value. No instance of this class must be
created. It is for this reason that this class is
deferred.

Constructor & Destructor Documentation

Dynamic_Parameter::Dynamic_Parameter ( const Standard_CString  aname)
protected

Initializer of this class taking in argument the name
of the parameter <aname>.

Member Function Documentation

virtual void Dynamic_Parameter::Dump ( Standard_OStream astream) const
virtual
TCollection_AsciiString Dynamic_Parameter::Name ( ) const

Returns in an AsciiString the name of the parameter.


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