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

This class simply allows to access an Integer value through a
Handle, as a String can be (by using HString).
Hence, this value can be accessed : read and modified, without
passing through the specific object which detains it. Thus,
parameters of a Selection or a Dispatch (according its type)
can be controlled directly from the ShareOut which contains them

Additionnaly, an IntParam can be bound to a Static.
Remember that for a String, binding is immediate, because the
string value of a Static is a HAsciiString, it then suffices
to get its Handle.
For an Integer, an IntParam can designate (by its name) a
Static : each time its value is required or set, the Static
is aknowledged
More...

#include <IFSelect_IntParam.hxx>

Inheritance diagram for IFSelect_IntParam:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_IntParam ()
 Creates an IntParam. Initial value is set to zer
More...
 
void SetStaticName (const Standard_CString statname)
 
 Commands this IntParam to be bound to a Static <br>
      Hence, Value will return the value if this Static if it is set <br>
      Else, Value works on the locally stored value <br>
      SetValue also will set the value of the Static <br>
      This works only for a present static of type integer or enum <br>
      Else, it is ignored <br>


If <statname> is empty, disconnects the IntParam from Static
More...

 
Standard_CString StaticName () const
 Returns the name of static parameter to which this IntParam
is bound, empty if none
More...
 
Standard_Integer Value () const
 Reads Integer Value of the IntParam. If a StaticName is
defined and the Static is set, looks in priority the value
of the static
More...
 
void SetValue (const Standard_Integer val)
 Sets a new Integer Value for the IntParam. If a StaticName is
defined and the Static is set, also sets the value of the static
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 simply allows to access an Integer value through a
Handle, as a String can be (by using HString).
Hence, this value can be accessed : read and modified, without
passing through the specific object which detains it. Thus,
parameters of a Selection or a Dispatch (according its type)
can be controlled directly from the ShareOut which contains them

Additionnaly, an IntParam can be bound to a Static.
Remember that for a String, binding is immediate, because the
string value of a Static is a HAsciiString, it then suffices
to get its Handle.
For an Integer, an IntParam can designate (by its name) a
Static : each time its value is required or set, the Static
is aknowledged

Constructor & Destructor Documentation

IFSelect_IntParam::IFSelect_IntParam ( )

Creates an IntParam. Initial value is set to zer

Member Function Documentation

void IFSelect_IntParam::SetStaticName ( const Standard_CString  statname)

 Commands this IntParam to be bound to a Static <br>
      Hence, Value will return the value if this Static if it is set <br>
      Else, Value works on the locally stored value <br>
      SetValue also will set the value of the Static <br>
      This works only for a present static of type integer or enum <br>
      Else, it is ignored <br>


If <statname> is empty, disconnects the IntParam from Static

void IFSelect_IntParam::SetValue ( const Standard_Integer  val)

Sets a new Integer Value for the IntParam. If a StaticName is
defined and the Static is set, also sets the value of the static

Standard_CString IFSelect_IntParam::StaticName ( ) const

Returns the name of static parameter to which this IntParam
is bound, empty if none

Standard_Integer IFSelect_IntParam::Value ( ) const

Reads Integer Value of the IntParam. If a StaticName is
defined and the Static is set, looks in priority the value
of the static


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