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. More...
#include <IFSelect_IntParam.hxx>
Public Member Functions | |
| IFSelect_IntParam () | |
| Creates an IntParam. Initial value is set to zer. | |
| void | SetStaticName (const Standard_CString statname) |
| Commands this IntParam to be bound to a Static Hence, Value will return the value if this Static if it is set Else, Value works on the locally stored value SetValue also will set the value of the Static This works only for a present static of type integer or enum Else, it is ignored. | |
| Standard_CString | StaticName () const |
| Returns the name of static parameter to which this IntParam is bound, empty if none. | |
| 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. | |
| 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. | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | IsKind (const opencascade::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. | |
| 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. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
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.
Additionally, 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::IFSelect_IntParam | ( | ) |
Creates an IntParam. Initial value is set to zer.
Member Function Documentation
◆ SetStaticName()
| void IFSelect_IntParam::SetStaticName | ( | const Standard_CString | statname | ) |
Commands this IntParam to be bound to a Static Hence, Value will return the value if this Static if it is set Else, Value works on the locally stored value SetValue also will set the value of the Static This works only for a present static of type integer or enum Else, it is ignored.
If <statname> is empty, disconnects the IntParam from Static
◆ SetValue()
| 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.
◆ StaticName()
| Standard_CString IFSelect_IntParam::StaticName | ( | ) | const |
Returns the name of static parameter to which this IntParam is bound, empty if none.
◆ Value()
| 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:
