 |
Open CASCADE Technology Reference Manual 8.0.0
|
Loading...
Searching...
No Matches
|
Open CASCADE Technology Reference Manual 8.0.0
|
This Signatures gives the Transfer Status of an entity, as recorded in a TransferProcess. It can be : More...
#include <XSControl_SignTransferStatus.hxx>
Public Member Functions | |
| XSControl_SignTransferStatus () | |
| Creates a SignTransferStatus, not initialised it gives nothing (empty string) | |
| XSControl_SignTransferStatus (const occ::handle< XSControl_TransferReader > &TR) | |
| Creates a SignTransferStatus, which will work on the current TransientProcess brought by the TransferReader (its MapReader) | |
| void | SetReader (const occ::handle< XSControl_TransferReader > &TR) |
| Sets a TransferReader to work. | |
| void | SetMap (const occ::handle< Transfer_TransientProcess > &TP) |
| Sets a precise map to sign entities This definition oversedes the creation with a TransferReader. | |
| occ::handle< Transfer_TransientProcess > | Map () const |
| Returns the TransientProcess used as precised one Returns a Null Handle for a creation from a TransferReader without any further setting. | |
| occ::handle< XSControl_TransferReader > | Reader () const |
| Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader. | |
| const char * | Value (const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model) const override |
| Returns the Signature for a Transient object, as its transfer status. | |
 Public Member Functions inherited from IFSelect_Signature | |
| void | SetIntCase (const bool hasmin, const int valmin, const bool hasmax, const int valmax) |
| Sets the information data to tell "integer cases" with possible min and max values To be called when creating. | |
| bool | IsIntCase (bool &hasmin, int &valmin, bool &hasmax, int &valmax) const |
| Tells if this Signature gives integer values and returns values from SetIntCase if True. | |
| void | AddCase (const char *const acase) |
| Adds a possible case To be called when creating, IF the list of possible cases for Value is known when starting For instance, for CDL types, rather do not fill this, but for a specific enumeration (such as a status), can be used. | |
| occ::handle< NCollection_HSequence< TCollection_AsciiString > > | CaseList () const |
| Returns the predefined list of possible cases, filled by AddCase Null Handle if no predefined list (hence, to be counted) Useful to filter on really possible vase, for instance, or for a help. | |
| const char * | Name () const override |
| Returns an identification of the Signature (a word), given at initialization time Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide "" It can work with the model which contains the entity. | |
| TCollection_AsciiString | Label () const |
| The label of a Signature uses its name as follow : "Signature : <name>". | |
| virtual bool | Matches (const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model, const TCollection_AsciiString &text, const bool exact) const |
| Tells if the value for <ent> in <model> matches a text, with a criterium <exact>. The default definition calls MatchValue Can be redefined. | |
| Public Member Functions inherited from Interface_SignType | |
| TCollection_AsciiString | Text (const occ::handle< Standard_Transient > &ent, const occ::handle< Standard_Transient > &context) const override |
| Returns an identification of the Signature (a word), given at initialization time Specialised to consider context as an InterfaceModel. | |
| Public Member Functions inherited from MoniTool_SignText | |
| virtual TCollection_AsciiString | TextAlone (const occ::handle< Standard_Transient > &ent) const |
| Gives a text as a signature for a transient object alone, i.e. without defined context. By default, calls Text with undefined context (Null Handle) and if empty, then returns DynamicType. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (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_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. | |
| 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 IFSelect_Signature | |
| static bool | MatchValue (const char *const val, const TCollection_AsciiString &text, const bool exact) |
| Default procedure to tell if a value <val> matches a text with a criterium <exact>. <exact> = True requires equality, else only contained (no reg-exp) | |
| static const char * | IntValue (const int val) |
| This procedure converts an Integer to a CString It is a convenient way when the value of a signature has the form of a simple integer value The value is to be used immediately (one buffer only, no copy) | |
| Static Public Member Functions inherited from Interface_SignType | |
| static const char * | ClassName (const char *const typnam) |
| From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_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 IFSelect_Signature | |
| IFSelect_Signature (const char *const name) | |
| Initializes a Signature with its name. | |
| Protected Attributes inherited from IFSelect_Signature | |
| TCollection_AsciiString | thename |
This Signatures gives the Transfer Status of an entity, as recorded in a TransferProcess. It can be :
| XSControl_SignTransferStatus::XSControl_SignTransferStatus | ( | ) |
Creates a SignTransferStatus, not initialised it gives nothing (empty string)
| XSControl_SignTransferStatus::XSControl_SignTransferStatus | ( | const occ::handle< XSControl_TransferReader > & | TR | ) |
Creates a SignTransferStatus, which will work on the current TransientProcess brought by the TransferReader (its MapReader)
| occ::handle< Transfer_TransientProcess > XSControl_SignTransferStatus::Map | ( | ) | const |
Returns the TransientProcess used as precised one Returns a Null Handle for a creation from a TransferReader without any further setting.
| occ::handle< XSControl_TransferReader > XSControl_SignTransferStatus::Reader | ( | ) | const |
Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader.
| void XSControl_SignTransferStatus::SetMap | ( | const occ::handle< Transfer_TransientProcess > & | TP | ) |
Sets a precise map to sign entities This definition oversedes the creation with a TransferReader.
| void XSControl_SignTransferStatus::SetReader | ( | const occ::handle< XSControl_TransferReader > & | TR | ) |
Sets a TransferReader to work.
|
overridevirtual |
Returns the Signature for a Transient object, as its transfer status.
Implements Interface_SignType.
1.10.0