defines basic controller for STEP processor More...
#include <STEPControl_Controller.hxx>
Inheritance diagram for STEPControl_Controller:
Public Member Functions | |
| STEPControl_Controller () | |
| Initializes the use of STEP Norm (the first time) and returns a Controller. More... | |
| Handle< Interface_InterfaceModel > | NewModel () const override |
| Creates a new empty Model ready to receive data of the Norm. It is taken from STEP Template Model. More... | |
| virtual void | Customise (Handle< XSControl_WorkSession > &WS) override |
| Customises a WorkSession, by adding to it the recorded items (by AddSessionItem) More... | |
| virtual IFSelect_ReturnStatus | TransferWriteShape (const TopoDS_Shape &shape, const Handle< Transfer_FinderProcess > &FP, const Handle< Interface_InterfaceModel > &model, const Standard_Integer modetrans=0, const Message_ProgressRange &theProgress=Message_ProgressRange()) const override |
| Takes one Shape and transfers it to the InterfaceModel (already created by NewModel for instance) <modeshape> is to be interpreted by each kind of XstepAdaptor Returns a status : 0 OK 1 No result 2 Fail -1 bad modeshape -2 bad model (requires a StepModel) modeshape : 1 Facetted BRep, 2 Shell, 3 Manifold Solid. More... | |
 Public Member Functions inherited from XSControl_Controller | |
| void | SetNames (const Standard_CString theLongName, const Standard_CString theShortName) |
| Changes names if a name is empty, the formerly set one remains Remark : Does not call Record or AutoRecord. More... | |
| void | AutoRecord () const |
| Records <me> is a general dictionary under Short and Long Names (see method Name) More... | |
| void | Record (const Standard_CString name) const |
| Records <me> in a general dictionary under a name Error if <name> already used for another one. More... | |
| Standard_CString | Name (const Standard_Boolean rsc=Standard_False) const |
| Returns a name, as given when initializing : rsc = False (D) : True Name attached to the Norm (long name) rsc = True : Name of the resource set (i.e. short name) More... | |
| const Handle< Interface_Protocol > & | Protocol () const |
| Returns the Protocol attached to the Norm (from field) More... | |
| const Handle< IFSelect_WorkLibrary > & | WorkLibrary () const |
| Returns the SignType attached to the norm (from field) More... | |
| virtual Handle< Transfer_ActorOfTransientProcess > | ActorRead (const Handle< Interface_InterfaceModel > &model) const |
| Returns the Actor for Read attached to the pair (norm,appli) It can be adapted for data of the input Model, as required Can be read from field then adapted with Model as required. More... | |
| virtual Handle< Transfer_ActorOfFinderProcess > | ActorWrite () const |
| Returns the Actor for Write attached to the pair (norm,appli) Read from field. Can be redefined. More... | |
| void | SetModeWrite (const Standard_Integer modemin, const Standard_Integer modemax, const Standard_Boolean shape=Standard_True) |
| Sets mininum and maximum values for modetrans (write) Erases formerly recorded bounds and values Actually only for shape Then, for each value a little help can be attached. More... | |
| void | SetModeWriteHelp (const Standard_Integer modetrans, const Standard_CString help, const Standard_Boolean shape=Standard_True) |
| Attaches a short line of help to a value of modetrans (write) More... | |
| Standard_Boolean | ModeWriteBounds (Standard_Integer &modemin, Standard_Integer &modemax, const Standard_Boolean shape=Standard_True) const |
| Returns recorded min and max values for modetrans (write) Actually only for shapes Returns True if bounds are set, False else (then, free value) More... | |
| Standard_Boolean | IsModeWrite (const Standard_Integer modetrans, const Standard_Boolean shape=Standard_True) const |
| Tells if a value of <modetrans> is a good value(within bounds) Actually only for shapes. More... | |
| Standard_CString | ModeWriteHelp (const Standard_Integer modetrans, const Standard_Boolean shape=Standard_True) const |
| Returns the help line recorded for a value of modetrans empty if help not defined or not within bounds or if values are free. More... | |
| virtual Standard_Boolean | RecognizeWriteTransient (const Handle< Standard_Transient > &obj, const Standard_Integer modetrans=0) const |
| Tells if <obj> (an application object) is a valid candidate for a transfer to a Model. By default, asks the ActorWrite if known (through a TransientMapper). Can be redefined. More... | |
| virtual IFSelect_ReturnStatus | TransferWriteTransient (const Handle< Standard_Transient > &obj, const Handle< Transfer_FinderProcess > &FP, const Handle< Interface_InterfaceModel > &model, const Standard_Integer modetrans=0, const Message_ProgressRange &theProgress=Message_ProgressRange()) const |
| Takes one Transient Object and transfers it to an InterfaceModel (already created, e.g. by NewModel) (result is recorded in the model by AddWithRefs) FP records produced results and checks. More... | |
| virtual Standard_Boolean | RecognizeWriteShape (const TopoDS_Shape &shape, const Standard_Integer modetrans=0) const |
| Tells if a shape is valid for a transfer to a model Asks the ActorWrite (through a ShapeMapper) More... | |
| void | AddSessionItem (const Handle< Standard_Transient > &theItem, const Standard_CString theName, const Standard_Boolean toApply=Standard_False) |
| Records a Session Item, to be added for customisation of the Work Session. It must have a specific name. <setapplied> is used if is a GeneralModifier, to decide If set to true, will be applied to the hook list "send". Else, it is not applied to any hook list. Remark : this method is to be called at Create time, the recorded items will be used by Customise Warning : if <name> conflicts, the last recorded item is kept. More... | |
| Handle< Standard_Transient > | SessionItem (const Standard_CString theName) const |
| Returns an item given its name to record in a Session If <name> is unknown, returns a Null Handle. More... | |
| const NCollection_DataMap< TCollection_AsciiString, Handle< Standard_Transient > > & | AdaptorSession () const |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::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 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. 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... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Static Public Member Functions | |
| static Standard_Boolean | Init () |
| Standard Initialisation. It creates a Controller for STEP and records it to various names, available to select it later Returns True when done, False if could not be done. More... | |
| Static Public Member Functions inherited from XSControl_Controller | |
| static Handle< XSControl_Controller > | Recorded (const Standard_CString name) |
| Returns the Controller attached to a given name Returns a Null Handle if <name> is unknown. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Protected Member Functions inherited from XSControl_Controller | |
| XSControl_Controller (const Standard_CString theLongName, const Standard_CString theShortName) | |
| Initializing with names <theLongName> is for the complete, official, long name <theShortName> is for the short name used for resources. More... | |
| void | TraceStatic (const Standard_CString theName, const Standard_Integer theUse) |
| Records the name of a Static to be traced for a given use. More... | |
| Protected Attributes inherited from XSControl_Controller | |
| TCollection_AsciiString | myShortName |
| TCollection_AsciiString | myLongName |
| Handle< IFSelect_WorkLibrary > | myAdaptorLibrary |
| Handle< Interface_Protocol > | myAdaptorProtocol |
| Handle< Transfer_ActorOfTransientProcess > | myAdaptorRead |
| Handle< Transfer_ActorOfFinderProcess > | myAdaptorWrite |
| NCollection_DataMap< TCollection_AsciiString, Handle< Standard_Transient > > | myAdaptorSession |
Detailed Description
defines basic controller for STEP processor
Constructor & Destructor Documentation
◆ STEPControl_Controller()
| STEPControl_Controller::STEPControl_Controller | ( | ) |
Initializes the use of STEP Norm (the first time) and returns a Controller.
Member Function Documentation
◆ Customise()
|
overridevirtual |
Customises a WorkSession, by adding to it the recorded items (by AddSessionItem)
Reimplemented from XSControl_Controller.
◆ Init()
|
static |
Standard Initialisation. It creates a Controller for STEP and records it to various names, available to select it later Returns True when done, False if could not be done.
◆ NewModel()
|
overridevirtual |
Creates a new empty Model ready to receive data of the Norm. It is taken from STEP Template Model.
Implements XSControl_Controller.
◆ TransferWriteShape()
|
overridevirtual |
Takes one Shape and transfers it to the InterfaceModel (already created by NewModel for instance) <modeshape> is to be interpreted by each kind of XstepAdaptor Returns a status : 0 OK 1 No result 2 Fail -1 bad modeshape -2 bad model (requires a StepModel) modeshape : 1 Facetted BRep, 2 Shell, 3 Manifold Solid.
Reimplemented from XSControl_Controller.
The documentation for this class was generated from the following file:
