Open CASCADE Technology  6.9.0
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 Standard_Integer numpar)
 Creates an SetGlobalParameter, to be applied on Global Parameter <numpar> More...
 
Standard_Integer GlobalNumber () const
 Returns the global parameter number to which this modifiers applies. More...
 
void SetValue (const Handle< TCollection_HAsciiString > &text)
 Sets a Text Parameter for the new value. More...
 
Handle< TCollection_HAsciiStringValue () const
 Returns the value to set to the global parameter (Text Param) More...
 
void Performing (IFSelect_ContextModif &ctx, const Handle< IGESData_IGESModel > &target, Interface_CopyTool &TC) const
 Specific action : only <target> is used : the form of the new value is checked regarding the parameter number (given at creation time). More...
 
TCollection_AsciiString Label () const
 Returns a text which is "Sets Global Parameter <numpar> to <new value>". More...
 
- 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
 This deferred method defines the action specific to each class of Modifier. It is called by a ModelCopier, once the Model generated and filled. ModelCopier has already checked the criteria (Dispatch, Model Rank, Selection) before calling it. More...
 
virtual void PerformProtocol (IFSelect_ContextModif &ctx, const Handle< IGESData_IGESModel > &target, const Handle< IGESData_Protocol > &proto, Interface_CopyTool &TC) const
 
- Public Member Functions inherited from IFSelect_GeneralModifier
Standard_Boolean MayChangeGraph () const
 Returns True if this modifier may change the graph of dependences (aknowledged at creation time) More...
 
void SetDispatch (const Handle< IFSelect_Dispatch > &disp)
 Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch) More...
 
Handle< IFSelect_DispatchDispatch () const
 Returns the Dispatch to be matched, Null if not set. More...
 
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> More...
 
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. More...
 
void ResetSelection ()
 Resets the Selection : this criterium is not longer active. More...
 
Standard_Boolean HasSelection () const
 Returns True if a Selection is set as an additionnal criterium. More...
 
Handle< IFSelect_SelectionSelection () const
 Returns the Selection, or a Null Handle if not set. 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 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 IGESSelect_ModelModifier
 IGESSelect_ModelModifier (const Standard_Boolean maychangegraph)
 
- Protected Member Functions inherited from IFSelect_Modifier
 IFSelect_Modifier (const Standard_Boolean maychangegraph)
 Calls inherited Initialize, transmits to it the information <maychangegraph> More...
 
- 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 : More...
 

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 ( const Standard_Integer  numpar)

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

Member Function Documentation

Standard_Integer IGESSelect_SetGlobalParameter::GlobalNumber ( ) const

Returns the global parameter number to which this modifiers applies.

TCollection_AsciiString IGESSelect_SetGlobalParameter::Label ( ) const
virtual

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

Implements IFSelect_GeneralModifier.

void IGESSelect_SetGlobalParameter::Performing ( IFSelect_ContextModif ctx,
const Handle< IGESData_IGESModel > &  target,
Interface_CopyTool TC 
) const
virtual

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.

void IGESSelect_SetGlobalParameter::SetValue ( const Handle< TCollection_HAsciiString > &  text)

Sets a Text Parameter for the new 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: