Open CASCADE Technology  7.7.0.dev
Public Member Functions

IGESData_FileProtocol Class Reference

This class allows to define complex protocols, in order to treat various sub-sets (or the complete set) of the IGES Norm, such as Solid + Draw (which are normally independent), etc... While it inherits Protocol from IGESData, it admits UndefinedEntity too. More...

#include <IGESData_FileProtocol.hxx>

Inheritance diagram for IGESData_FileProtocol:
Inheritance graph
[legend]

Public Member Functions

 IGESData_FileProtocol ()
 Returns an empty FileProtocol. More...
 
void Add (const Handle< IGESData_Protocol > &protocol)
 Adds a resource. More...
 
virtual Standard_Integer NbResources () const override
 Gives the count of Resources : the count of Added Protocols. More...
 
virtual Handle< Interface_ProtocolResource (const Standard_Integer num) const override
 Returns a Resource, given a rank (rank of call to Add) More...
 
- Public Member Functions inherited from IGESData_Protocol
 IGESData_Protocol ()
 
Standard_Integer NbResources () const override
 Gives the count of Resource Protocol. Here, none. More...
 
Handle< Interface_ProtocolResource (const Standard_Integer num) const override
 Returns a Resource, given a rank. Here, none. More...
 
Standard_Integer TypeNumber (const Handle< Standard_Type > &atype) const override
 Returns a Case Number, specific of each recognized Type Here, Undefined and Free Format Entities have the Number 1. More...
 
Handle< Interface_InterfaceModelNewModel () const override
 Creates an empty Model for IGES Norm. More...
 
Standard_Boolean IsSuitableModel (const Handle< Interface_InterfaceModel > &model) const override
 Returns True if <model> is a Model of IGES Norm. More...
 
Handle< Standard_TransientUnknownEntity () const override
 Creates a new Unknown Entity for IGES (UndefinedEntity) More...
 
Standard_Boolean IsUnknownEntity (const Handle< Standard_Transient > &ent) const override
 Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown. More...
 
- Public Member Functions inherited from Interface_Protocol
virtual Standard_Integer CaseNumber (const Handle< Standard_Transient > &obj) const
 Returns a unique positive CaseNumber for each Recognized Object. By default, recognition is based on Type(1) By default, calls the following one which is deferred. More...
 
virtual Standard_Boolean IsDynamicType (const Handle< Standard_Transient > &obj) const
 Returns True if type of <obj> is that defined from CDL This is the default but it may change according implementation. More...
 
virtual Standard_Integer NbTypes (const Handle< Standard_Transient > &obj) const
 Returns the count of DISTINCT types under which an entity may be processed. Each one is candidate to be recognized by TypeNumber, <obj> is then processed according it By default, returns 1 (the DynamicType) More...
 
Handle< Standard_TypeType (const Handle< Standard_Transient > &obj, const Standard_Integer nt=1) const
 Returns a type under which <obj> can be recognized and processed, according its rank in its definition list (see NbTypes). By default, returns DynamicType. More...
 
virtual Standard_Boolean GlobalCheck (const Interface_Graph &G, Handle< Interface_Check > &ach) const
 Evaluates a Global Check for a model (with its Graph) Returns True when done, False if data in model do not apply. 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 Interface_Protocol
static Handle< Interface_ProtocolActive ()
 Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol") More...
 
static void SetActive (const Handle< Interface_Protocol > &aprotocol)
 Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol. More...
 
static void ClearActive ()
 Erases the Active Protocol (hence it becomes undefined) 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...
 

Detailed Description

This class allows to define complex protocols, in order to treat various sub-sets (or the complete set) of the IGES Norm, such as Solid + Draw (which are normally independent), etc... While it inherits Protocol from IGESData, it admits UndefinedEntity too.

Constructor & Destructor Documentation

◆ IGESData_FileProtocol()

IGESData_FileProtocol::IGESData_FileProtocol ( )

Returns an empty FileProtocol.

Member Function Documentation

◆ Add()

void IGESData_FileProtocol::Add ( const Handle< IGESData_Protocol > &  protocol)

Adds a resource.

◆ NbResources()

virtual Standard_Integer IGESData_FileProtocol::NbResources ( ) const
overridevirtual

Gives the count of Resources : the count of Added Protocols.

Implements Interface_Protocol.

◆ Resource()

virtual Handle< Interface_Protocol > IGESData_FileProtocol::Resource ( const Standard_Integer  num) const
overridevirtual

Returns a Resource, given a rank (rank of call to Add)

Implements Interface_Protocol.


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