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

This class is the root class for describing
variables. A variable is useful to specify the
signature of a method in terms of arguments and if
necessary variables and/or constants needed inside
a function. This set of information defines a
scope for these variables. This class is directly
used by the MethodDefinition class. From this
class is derived the instances of variables which
are used by the classes under the MethodInstance
class. A variable is composed by :

More...

#include <Dynamic_Variable.hxx>

Inheritance diagram for Dynamic_Variable:
Inheritance graph
[legend]

Public Member Functions

 Dynamic_Variable ()
 Creates and returns an empty instance of this class.
More...
 
void Parameter (const Handle< Dynamic_Parameter > &aparameter)
 Sets the parameter <aparameter> in <me>. This
parameter gives the name, the type of value, and if
necessary the default value of the variable.
More...
 
Handle_Dynamic_Parameter Parameter () const
 Returns the parameter stored in <me>.
More...
 
void Mode (const Dynamic_ModeEnum amode)
 Sets the mode to the variable. the mode is to take in
the enumeration IN, OUT, INOUT, INTERNAL, CONSTANT,
which describes the type of the variable.
More...
 
Dynamic_ModeEnum Mode () const
 Returns the mode of the variable.
More...
 
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...
 

Detailed Description

This class is the root class for describing
variables. A variable is useful to specify the
signature of a method in terms of arguments and if
necessary variables and/or constants needed inside
a function. This set of information defines a
scope for these variables. This class is directly
used by the MethodDefinition class. From this
class is derived the instances of variables which
are used by the classes under the MethodInstance
class. A variable is composed by :

     * an identifier for giving it a name, <br>
     * a type of expected value, <br>
     * possibly a default value, <br>
     * a mode which explains if the variable is : <br>


Constructor & Destructor Documentation

Dynamic_Variable::Dynamic_Variable ( )

Creates and returns an empty instance of this class.

Member Function Documentation

void Dynamic_Variable::Dump ( Standard_OStream astream) const

Useful for debugging.

void Dynamic_Variable::Mode ( const Dynamic_ModeEnum  amode)

Sets the mode to the variable. the mode is to take in
the enumeration IN, OUT, INOUT, INTERNAL, CONSTANT,
which describes the type of the variable.

Dynamic_ModeEnum Dynamic_Variable::Mode ( ) const

Returns the mode of the variable.

void Dynamic_Variable::Parameter ( const Handle< Dynamic_Parameter > &  aparameter)

Sets the parameter <aparameter> in <me>. This
parameter gives the name, the type of value, and if
necessary the default value of the variable.

Handle_Dynamic_Parameter Dynamic_Variable::Parameter ( ) const

Returns the parameter stored in <me>.


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