Open CASCADE Technology  7.7.0.dev
Public Member Functions

Transfer_BinderOfTransientInteger Class Reference

This type of Binder allows to attach as result, besides a Transient Object, an Integer Value, which can be an Index in the Object if it defines a List, for instance. More...

#include <Transfer_BinderOfTransientInteger.hxx>

Inheritance diagram for Transfer_BinderOfTransientInteger:
Inheritance graph
[legend]

Public Member Functions

 Transfer_BinderOfTransientInteger ()
 Creates an empty BinderOfTransientInteger; Default value for the integer part is zero. More...
 
void SetInteger (const Standard_Integer value)
 Sets a value for the integer part. More...
 
Standard_Integer Integer () const
 Returns the value set for the integer part. More...
 
- Public Member Functions inherited from Transfer_SimpleBinderOfTransient
 Transfer_SimpleBinderOfTransient ()
 Creates an empty SimpleBinderOfTransient Returns True if a starting object is bound with SEVERAL results : Here, returns always False See Binder itself. More...
 
Handle< Standard_TypeResultType () const override
 Returns the Effective (Dynamic) Type of the Result (Standard_Transient if no Result is defined) More...
 
Standard_CString ResultTypeName () const override
 Returns the Effective Name of (Dynamic) Type of the Result (void) if no result is defined. More...
 
void SetResult (const Handle< Standard_Transient > &res)
 Defines the Result. More...
 
const Handle< Standard_Transient > & Result () const
 Returns the defined Result, if there is one. More...
 
- Public Member Functions inherited from Transfer_Binder
void Merge (const Handle< Transfer_Binder > &other)
 Merges basic data (Check, ExecStatus) from another Binder but keeps its result. Used when a binder is replaced by another one, this allows to keep messages. More...
 
virtual Standard_Boolean IsMultiple () const
 Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes. More...
 
void AddResult (const Handle< Transfer_Binder > &next)
 Adds a next result (at the end of the list) Remark : this information is not processed by Merge. More...
 
Handle< Transfer_BinderNextResult () const
 Returns the next result, Null if none. More...
 
Standard_Boolean HasResult () const
 Returns True if a Result is available (StatusResult = Defined) A Unique Result will be gotten by Result (which must be defined in each sub-class according to result type) For a Multiple Result, see class MultipleBinder For other case, specific access has to be forecast. More...
 
void SetAlreadyUsed ()
 Declares that result is now used by another one, it means that it cannot be modified (by Rebind) More...
 
Transfer_StatusResult Status () const
 Returns status, which can be Initial (not yet done), Made (a result is recorded, not yet shared), Used (it is shared and cannot be modified) More...
 
Transfer_StatusExec StatusExec () const
 Returns execution status. More...
 
void SetStatusExec (const Transfer_StatusExec stat)
 Modifies execution status; called by TransferProcess only (for StatusError, rather use SetError, below) More...
 
void AddFail (const Standard_CString mess, const Standard_CString orig="")
 Used to declare an individual transfer as being erroneous (Status is set to Void, StatusExec is set to Error, <errmess> is added to Check's list of Fails) It is possible to record several messages of error. More...
 
void AddWarning (const Standard_CString mess, const Standard_CString orig="")
 Used to attach a Warning Message to an individual Transfer It has no effect on the Status. More...
 
const Handle< Interface_CheckCheck () const
 Returns Check which stores Fail messages Note that no Entity is associated in this Check. More...
 
Handle< Interface_CheckCCheck ()
 Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it) More...
 
 ~Transfer_Binder ()
 Destructor. 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 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_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. 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Transfer_SimpleBinderOfTransient
static Standard_Boolean GetTypedResult (const Handle< Transfer_Binder > &bnd, const Handle< Standard_Type > &atype, Handle< Standard_Transient > &res)
 Returns a transient result according to its type (IsKind) i.e. the result itself if IsKind(atype), else searches in NextResult, until first found, then returns True If not found, returns False (res is NOT touched) 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...
 
- Protected Member Functions inherited from Transfer_Binder
 Transfer_Binder ()
 Sets fields at initial values. More...
 
void SetResultPresent ()
 Used to declare that a result is recorded for an individual transfer (works by setting StatusResult to Defined) More...
 

Detailed Description

This type of Binder allows to attach as result, besides a Transient Object, an Integer Value, which can be an Index in the Object if it defines a List, for instance.

This Binder is otherwise a kind of SimpleBinderOfTransient, i.e. its basic result (for iterators, etc) is the Transient

Constructor & Destructor Documentation

◆ Transfer_BinderOfTransientInteger()

Transfer_BinderOfTransientInteger::Transfer_BinderOfTransientInteger ( )

Creates an empty BinderOfTransientInteger; Default value for the integer part is zero.

Member Function Documentation

◆ Integer()

Standard_Integer Transfer_BinderOfTransientInteger::Integer ( ) const

Returns the value set for the integer part.

◆ SetInteger()

void Transfer_BinderOfTransientInteger::SetInteger ( const Standard_Integer  value)

Sets a value for the integer part.


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