IGESSelect_SetGlobalParameter Class Reference
Sets a Global (Header) Parameter to a new value, directly given Controls the form of the parameter (Integer, Real, String with such or such form), but not the consistence of the new value regarding the rest of the file. More...
#include <IGESSelect_SetGlobalParameter.hxx>
Inheritance diagram for IGESSelect_SetGlobalParameter:
Public Member Functions | |
| IGESSelect_SetGlobalParameter (const Standard_Integer numpar) | |
| Creates an SetGlobalParameter, to be applied on Global Parameter <numpar> | |
| Standard_Integer | GlobalNumber () const |
| Returns the global parameter number to which this modifiers applies. | |
| void | SetValue (const Handle< TCollection_HAsciiString > &text) |
| Sets a Text Parameter for the new value. | |
| Handle< TCollection_HAsciiString > | Value () const |
| Returns the value to set to the global parameter (Text Param) | |
| void | Performing (IFSelect_ContextModif &ctx, const Handle< IGESData_IGESModel > &target, Interface_CopyTool &TC) const override |
| Specific action : only <target> is used : the form of the new value is checked regarding the parameter number (given at creation time). | |
| TCollection_AsciiString | Label () const override |
| Returns a text which is "Sets Global Parameter <numpar> to <new value>". | |
 Public Member Functions inherited from IGESSelect_ModelModifier | |
| void | Perform (IFSelect_ContextModif &ctx, const Handle< Interface_InterfaceModel > &target, const Handle< Interface_Protocol > &protocol, Interface_CopyTool &TC) const override |
| The inherited Perform does the required cast (and refuses to go further if cast has failed) then calls the instantiated Performing. | |
| virtual void | PerformProtocol (IFSelect_ContextModif &ctx, const Handle< IGESData_IGESModel > &target, const Handle< IGESData_Protocol > &proto, Interface_CopyTool &TC) const |
| Specific Perform with Protocol. It is defined to let the Protocol unused and to call Performing without Protocol (most current case). It can be redefined if specific action requires Protocol. | |
| Public Member Functions inherited from IFSelect_Modifier | |
| Public Member Functions inherited from IFSelect_GeneralModifier | |
| Standard_Boolean | MayChangeGraph () const |
| Returns True if this modifier may change the graph of dependences (acknowledged at creation time) | |
| void | SetDispatch (const Handle< IFSelect_Dispatch > &disp) |
| Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch) | |
| Handle< IFSelect_Dispatch > | Dispatch () const |
| Returns the Dispatch to be matched, Null if not set. | |
| Standard_Boolean | Applies (const Handle< IFSelect_Dispatch > &disp) const |
| Returns True if a Model obtained from the Dispatch <disp> is to be treated (apart from the Selection criterium) If Dispatch(me) is Null, returns True. Else, checks <disp> | |
| void | SetSelection (const Handle< IFSelect_Selection > &sel) |
| Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection. | |
| void | ResetSelection () |
| Resets the Selection : this criterium is not longer active. | |
| Standard_Boolean | HasSelection () const |
| Returns True if a Selection is set as an additional criterium. | |
| Handle< IFSelect_Selection > | Selection () const |
| Returns the Selection, or a Null Handle if not set. | |
| 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. | |
| Protected Member Functions inherited from IGESSelect_ModelModifier | |
| IGESSelect_ModelModifier (const Standard_Boolean maychangegraph) | |
| Calls inherited Initialize, transmits to it the information <maychangegraph> | |
| Protected Member Functions inherited from IFSelect_Modifier | |
| IFSelect_Modifier (const Standard_Boolean maychangegraph) | |
| Calls inherited Initialize, transmits to it the information <maychangegraph> | |
| Protected Member Functions inherited from IFSelect_GeneralModifier | |
| IFSelect_GeneralModifier (const Standard_Boolean maychangegraph) | |
| Sets the Modifier criteria to default Values (i.e. "always applies") <maychangegraph> must be provided at creation time, to : | |
Detailed Description
Sets a Global (Header) Parameter to a new value, directly given Controls the form of the parameter (Integer, Real, String with such or such form), but not the consistence of the new value regarding the rest of the file.
The new value is given under the form of a HAsciiString, even for Integer or Real values. For String values, Hollerith forms are accepted but not mandatory Warning : a Null (not set) value is not accepted. For an empty string, give a Text Parameter which is empty
Constructor & Destructor Documentation
◆ IGESSelect_SetGlobalParameter()
| IGESSelect_SetGlobalParameter::IGESSelect_SetGlobalParameter | ( | const Standard_Integer | numpar | ) |
Creates an SetGlobalParameter, to be applied on Global Parameter <numpar>
Member Function Documentation
◆ GlobalNumber()
| Standard_Integer IGESSelect_SetGlobalParameter::GlobalNumber | ( | ) | const |
Returns the global parameter number to which this modifiers applies.
◆ Label()
|
overridevirtual |
Returns a text which is "Sets Global Parameter <numpar> to <new value>".
Implements IFSelect_GeneralModifier.
◆ Performing()
|
overridevirtual |
Specific action : only <target> is used : the form of the new value is checked regarding the parameter number (given at creation time).
Implements IGESSelect_ModelModifier.
◆ SetValue()
| void IGESSelect_SetGlobalParameter::SetValue | ( | const Handle< TCollection_HAsciiString > & | text | ) |
Sets a Text Parameter for the new value.
◆ Value()
| Handle< TCollection_HAsciiString > IGESSelect_SetGlobalParameter::Value | ( | ) | const |
Returns the value to set to the global parameter (Text Param)
The documentation for this class was generated from the following file:
Generated by
1.12.0