Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
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:
Inheritance graph
[legend]

Public Member Functions

 IGESSelect_SetGlobalParameter (const int numpar)
 Creates an SetGlobalParameter, to be applied on Global Parameter <numpar>
 
int GlobalNumber () const
 Returns the global parameter number to which this modifiers applies.
 
void SetValue (const occ::handle< TCollection_HAsciiString > &text)
 Sets a Text Parameter for the new value.
 
occ::handle< TCollection_HAsciiStringValue () const
 Returns the value to set to the global parameter (Text Param)
 
void Performing (IFSelect_ContextModif &ctx, const occ::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 occ::handle< Interface_InterfaceModel > &target, const occ::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 occ::handle< IGESData_IGESModel > &target, const occ::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_GeneralModifier
bool MayChangeGraph () const
 Returns True if this modifier may change the graph of dependences (acknowledged at creation time)
 
void SetDispatch (const occ::handle< IFSelect_Dispatch > &disp)
 Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch)
 
occ::handle< IFSelect_DispatchDispatch () const
 Returns the Dispatch to be matched, Null if not set.
 
bool Applies (const occ::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 occ::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.
 
bool HasSelection () const
 Returns True if a Selection is set as an additional criterium.
 
occ::handle< IFSelect_SelectionSelection () 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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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_TransientThis () 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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
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 charget_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 bool maychangegraph)
 Calls inherited Initialize, transmits to it the information <maychangegraph>
 
- Protected Member Functions inherited from IFSelect_Modifier
 IFSelect_Modifier (const bool maychangegraph)
 Calls inherited Initialize, transmits to it the information <maychangegraph>
 
- Protected Member Functions inherited from IFSelect_GeneralModifier
 IFSelect_GeneralModifier (const bool 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 int numpar)

Creates an SetGlobalParameter, to be applied on Global Parameter <numpar>

Member Function Documentation

◆ GlobalNumber()

int IGESSelect_SetGlobalParameter::GlobalNumber ( ) const

Returns the global parameter number to which this modifiers applies.

◆ Label()

TCollection_AsciiString IGESSelect_SetGlobalParameter::Label ( ) const
overridevirtual

Returns a text which is "Sets Global Parameter <numpar> to <new value>".

Implements IFSelect_GeneralModifier.

◆ Performing()

void IGESSelect_SetGlobalParameter::Performing ( IFSelect_ContextModif & ctx,
const occ::handle< IGESData_IGESModel > & target,
Interface_CopyTool & TC ) const
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 occ::handle< TCollection_HAsciiString > & text)

Sets a Text Parameter for the new value.

◆ Value()

occ::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: