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

This inherited class is for describing the
definition of a method. This definition is
composed by its name which is readable by the type
function and a collection of variables which
defines the signature of the method definition in
term of arguments passed to the function and also
the useful internal or constant variables if the
function is a composite method. This class is also
a deferred class and can not be used directly
because it is necessary to specify if the method
is compiled, interpreted or composite.
More...

#include <Dynamic_MethodDefinition.hxx>

Inheritance diagram for Dynamic_MethodDefinition:
Inheritance graph
[legend]

Public Member Functions

virtual TCollection_AsciiString Type () const
 Returns the name of the method definition.
More...
 
void AddVariable (const Handle< Dynamic_Parameter > &aparameter, const Dynamic_ModeEnum amode, const Standard_Boolean agroup=Standard_False)
 Adds a new variable created from the parameter
<aparameter>, which defines the name of the variable
its type and if necessary its default value, the mode
<amode> which precise if it is an in, out, inout,
internal or constant variable and the flag <agroup>
for accepting a set of homogeneous variables. with
the parameter value <aparameter>.
More...
 
virtual void Dump (Standard_OStream &astream) const
 Useful for debugging.
More...
 
- Public Member Functions inherited from Dynamic_Method
Handle_Dynamic_VariableNode FirstVariableNode () const
 Returns the first variable node of the Method which
contains a variable.
More...
 
Standard_Boolean Variable (const Standard_CString avariable) const
 Returns true if there is a variable with <avariable>
as name, false otherwise.
More...
 
void Variable (const Handle< Dynamic_Variable > &avariable)
 Adds another variable <avariable> to the sequence of
variable definitions.
More...
 
Standard_Boolean Value (const Standard_CString aname, Handle< Dynamic_Parameter > &aparameter, Dynamic_ModeEnum &amode) const
 Returns True, if there is a variable <avariable>
previously stored in the instance <me> and there is
the corresponding parameter value in the output
argument <aparameter>, False otherwise.
More...
 
Standard_Boolean Value (const Standard_CString aname, Handle< Dynamic_Variable > &avariable) const
 Returns True, if there is a variable named <aname>
previously stored in the instance of <me> and returns
the corresponding variable in the output argument
<avariable>, False otherwise.
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_MethodDefinition (const Standard_CString aname)
 Creates a MethodDefinition with <aname> as type.
More...
 
- Protected Member Functions inherited from Dynamic_Method
 Dynamic_Method ()
 It is the constructor of this deferred class
More...
 

Detailed Description

This inherited class is for describing the
definition of a method. This definition is
composed by its name which is readable by the type
function and a collection of variables which
defines the signature of the method definition in
term of arguments passed to the function and also
the useful internal or constant variables if the
function is a composite method. This class is also
a deferred class and can not be used directly
because it is necessary to specify if the method
is compiled, interpreted or composite.

Constructor & Destructor Documentation

Dynamic_MethodDefinition::Dynamic_MethodDefinition ( const Standard_CString  aname)
protected

Creates a MethodDefinition with <aname> as type.

Member Function Documentation

void Dynamic_MethodDefinition::AddVariable ( const Handle< Dynamic_Parameter > &  aparameter,
const Dynamic_ModeEnum  amode,
const Standard_Boolean  agroup = Standard_False 
)

Adds a new variable created from the parameter
<aparameter>, which defines the name of the variable
its type and if necessary its default value, the mode
<amode> which precise if it is an in, out, inout,
internal or constant variable and the flag <agroup>
for accepting a set of homogeneous variables. with
the parameter value <aparameter>.

virtual void Dynamic_MethodDefinition::Dump ( Standard_OStream astream) const
virtual

Useful for debugging.

Reimplemented from Dynamic_Method.

Reimplemented in Dynamic_CompositMethod.

virtual TCollection_AsciiString Dynamic_MethodDefinition::Type ( ) const
virtual

Returns the name of the method definition.

Implements Dynamic_Method.


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