Open CASCADE Technology 7.8.0
Public Member Functions
Interface_CopyControl Class Referenceabstract

This deferred class describes the services required by CopyTool to work. They are very simple and correspond basically to the management of an indexed map. But they can be provided by various classes which can control a Transfer. Each Starting Entity have at most one Result (Mapping one-one) More...

#include <Interface_CopyControl.hxx>

Inheritance diagram for Interface_CopyControl:
Inheritance graph
[legend]

Public Member Functions

virtual void Clear ()=0
 Clears List of Copy Results. Gets Ready to begin another Copy Process.
 
virtual void Bind (const Handle< Standard_Transient > &ent, const Handle< Standard_Transient > &res)=0
 Bind a Result to a Starting Entity identified by its Number.
 
virtual Standard_Boolean Search (const Handle< Standard_Transient > &ent, Handle< Standard_Transient > &res) const =0
 Searches for the Result bound to a Startingf Entity identified by its Number. If Found, returns True and fills <res> Else, returns False and nullifies <res>
 
- 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 ()
 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_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.
 
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 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.
 

Detailed Description

This deferred class describes the services required by CopyTool to work. They are very simple and correspond basically to the management of an indexed map. But they can be provided by various classes which can control a Transfer. Each Starting Entity have at most one Result (Mapping one-one)

Member Function Documentation

◆ Bind()

virtual void Interface_CopyControl::Bind ( const Handle< Standard_Transient > &  ent,
const Handle< Standard_Transient > &  res 
)
pure virtual

Bind a Result to a Starting Entity identified by its Number.

Implemented in Interface_CopyMap, and Transfer_DispatchControl.

◆ Clear()

virtual void Interface_CopyControl::Clear ( )
pure virtual

Clears List of Copy Results. Gets Ready to begin another Copy Process.

Implemented in Interface_CopyMap, and Transfer_DispatchControl.

◆ Search()

virtual Standard_Boolean Interface_CopyControl::Search ( const Handle< Standard_Transient > &  ent,
Handle< Standard_Transient > &  res 
) const
pure virtual

Searches for the Result bound to a Startingf Entity identified by its Number. If Found, returns True and fills <res> Else, returns False and nullifies <res>

Implemented in Interface_CopyMap, and Transfer_DispatchControl.


The documentation for this class was generated from the following file: