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

This inherited class from Parameter describes all
the parameters, which are characterized by a
string value.
More...

#include <Dynamic_StringParameter.hxx>

Inheritance diagram for Dynamic_StringParameter:
Inheritance graph
[legend]

Public Member Functions

 Dynamic_StringParameter (const Standard_CString aparameter)
 Creates a StringParameter with <aparameter> as name.
More...
 
 Dynamic_StringParameter (const Standard_CString aparameter, const Standard_CString astring)
 With the name of the Parameter <aparameter> and the
string <astring>, creates an instance of
StringParameter.
More...
 
TCollection_AsciiString Value () const
 Returns the value of the parameter which is an
AsciiString.
More...
 
void Value (const Standard_CString avalue)
 Sets the string <avalue> in <me>.
More...
 
virtual void Dump (Standard_OStream &astream) const
 Useful for debugging.
More...
 
- Public Member Functions inherited from Dynamic_Parameter
TCollection_AsciiString Name () const
 Returns in an AsciiString the name of the parameter.
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...
 

Additional Inherited Members

- Protected Member Functions inherited from Dynamic_Parameter
 Dynamic_Parameter (const Standard_CString aname)
 Initializer of this class taking in argument the name
of the parameter <aname>.
More...
 

Detailed Description

This inherited class from Parameter describes all
the parameters, which are characterized by a
string value.

Constructor & Destructor Documentation

Dynamic_StringParameter::Dynamic_StringParameter ( const Standard_CString  aparameter)

Creates a StringParameter with <aparameter> as name.

Dynamic_StringParameter::Dynamic_StringParameter ( const Standard_CString  aparameter,
const Standard_CString  astring 
)

With the name of the Parameter <aparameter> and the
string <astring>, creates an instance of
StringParameter.

Member Function Documentation

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

Useful for debugging.

Reimplemented from Dynamic_Parameter.

TCollection_AsciiString Dynamic_StringParameter::Value ( ) const

Returns the value of the parameter which is an
AsciiString.

void Dynamic_StringParameter::Value ( const Standard_CString  avalue)

Sets the string <avalue> in <me>.


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