A FileProtocol is defined as the addition of several already existing Protocols. It corresponds to the definition of a SchemaName with several Names, each one being attached to a specific Protocol. Thus, a File defined with a compound Schema is processed as any other one, once built the equivalent compound Protocol, a FileProtocol. More...

#include <StepData_FileProtocol.hxx>

Inheritance diagram for StepData_FileProtocol:

[legend]

Public Member Functions
	StepData_FileProtocol ()
	Creates an empty FileProtocol.

void	Add (const occ::handle< StepData_Protocol > &protocol)
	Adds a Protocol to the definition list of the FileProtocol But ensures that each class of Protocol is present only once in this list.

int	NbResources () const override
	Gives the count of Protocols used as Resource (can be zero) i.e. the count of Protocol recorded by calling the method Add.

occ::handle< Interface_Protocol >	Resource (const int num) const override
	Returns a Resource, given a rank. Here, rank of calling Add.

int	TypeNumber (const occ::handle< Standard_Type > &atype) const override
	Returns a Case Number, specific of each recognized Type Here, NO Type at all is recognized properly : all Types are recognized by the resources.

bool	GlobalCheck (const Interface_Graph &G, occ::handle< Interface_Check > &ach) const override
	Calls GlobalCheck for each of its recorded resources.

const char *	SchemaName (const occ::handle< Interface_InterfaceModel > &theModel) const override
	Returns the Schema Name attached to each class of Protocol To be redefined by each sub-class Here, SchemaName returns "" (empty String) was C++ : return const.

Public Member Functions inherited from StepData_Protocol
	StepData_Protocol ()

int	NbResources () const override
	Gives the count of Protocols used as Resource (can be zero) Here, No resource.

occ::handle< Interface_Protocol >	Resource (const int num) const override
	Returns a Resource, given a rank. Here, none.

int	CaseNumber (const occ::handle< Standard_Transient > &obj) const override
	Returns a unique positive number for any recognized entity Redefined to work by calling both TypeNumber and, for a Described Entity (late binding) DescrNumber.

int	TypeNumber (const occ::handle< Standard_Type > &atype) const override
	Returns a Case Number, specific of each recognized Type Here, only Unknown Entity is recognized.

occ::handle< Interface_InterfaceModel >	NewModel () const override
	Creates an empty Model for Step Norm.

bool	IsSuitableModel (const occ::handle< Interface_InterfaceModel > &model) const override
	Returns True if <model> is a Model of Step Norm.

occ::handle< Standard_Transient >	UnknownEntity () const override
	Creates a new Unknown Entity for Step (UndefinedEntity)

bool	IsUnknownEntity (const occ::handle< Standard_Transient > &ent) const override
	Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown.

virtual int	DescrNumber (const occ::handle< StepData_EDescr > &adescr) const
	Returns a unique positive CaseNumber for types described by an EDescr (late binding) Warning : TypeNumber and DescrNumber must give together a unique positive case number for each distinct case, type or descr.

void	AddDescr (const occ::handle< StepData_EDescr > &adescr, const int CN)
	Records an EDescr with its case number Also records its name for an ESDescr (simple type): an ESDescr is then used, for case number, or for type name.

bool	HasDescr () const
	Tells if a Protocol brings at least one ESDescr, i.e. if it defines at least one entity description by ESDescr mechanism.

occ::handle< StepData_EDescr >	Descr (const int num) const
	Returns the description attached to a case number, or null.

occ::handle< StepData_EDescr >	Descr (const char *const name, const bool anylevel=true) const
	Returns a description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

occ::handle< StepData_ESDescr >	ESDescr (const char *const name, const bool anylevel=true) const
	Idem as Descr but cast to simple description.

occ::handle< StepData_ECDescr >	ECDescr (const NCollection_Sequence< TCollection_AsciiString > &names, const bool anylevel=true) const
	Returns a complex description according to list of names <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

void	AddPDescr (const occ::handle< StepData_PDescr > &pdescr)
	Records an PDescr.

occ::handle< StepData_PDescr >	PDescr (const char *const name, const bool anylevel=true) const
	Returns a parameter description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

void	AddBasicDescr (const occ::handle< StepData_ESDescr > &esdescr)
	Records an ESDescr, intended to build complex descriptions.

occ::handle< StepData_EDescr >	BasicDescr (const char *const name, const bool anylevel=true) const
	Returns a basic description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

Public Member Functions inherited from Interface_Protocol
virtual bool	IsDynamicType (const occ::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.

virtual int	NbTypes (const occ::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)

occ::handle< Standard_Type >	Type (const occ::handle< Standard_Transient > &obj, const int 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.

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 Interface_Protocol
static occ::handle< Interface_Protocol >	Active ()
	Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol")

static void	SetActive (const occ::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.

static void	ClearActive ()
	Erases the Active Protocol (hence it becomes undefined)

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.

Detailed Description

A FileProtocol is defined as the addition of several already existing Protocols. It corresponds to the definition of a SchemaName with several Names, each one being attached to a specific Protocol. Thus, a File defined with a compound Schema is processed as any other one, once built the equivalent compound Protocol, a FileProtocol.

Constructor & Destructor Documentation

◆ StepData_FileProtocol()

StepData_FileProtocol::StepData_FileProtocol ( )

Creates an empty FileProtocol.

Member Function Documentation

◆ Add()

void StepData_FileProtocol::Add ( const occ::handle< StepData_Protocol > & protocol )

Adds a Protocol to the definition list of the FileProtocol But ensures that each class of Protocol is present only once in this list.

◆ GlobalCheck()

bool StepData_FileProtocol::GlobalCheck	(	const Interface_Graph &	G,
		occ::handle< Interface_Check > &	ach ) const

overridevirtual

Calls GlobalCheck for each of its recorded resources.

Reimplemented from Interface_Protocol.

◆ NbResources()

int StepData_FileProtocol::NbResources ( ) const

overridevirtual

Gives the count of Protocols used as Resource (can be zero) i.e. the count of Protocol recorded by calling the method Add.

Implements Interface_Protocol.

◆ Resource()

occ::handle< Interface_Protocol > StepData_FileProtocol::Resource ( const int num ) const

overridevirtual

Returns a Resource, given a rank. Here, rank of calling Add.

Implements Interface_Protocol.

◆ SchemaName()

const char * StepData_FileProtocol::SchemaName ( const occ::handle< Interface_InterfaceModel > & theModel ) const

overridevirtual

Returns the Schema Name attached to each class of Protocol To be redefined by each sub-class Here, SchemaName returns "" (empty String) was C++ : return const.

Reimplemented from StepData_Protocol.

◆ TypeNumber()

int StepData_FileProtocol::TypeNumber ( const occ::handle< Standard_Type > & atype ) const

overridevirtual

Returns a Case Number, specific of each recognized Type Here, NO Type at all is recognized properly : all Types are recognized by the resources.

Implements Interface_Protocol.

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

StepData_FileProtocol.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StepData_FileProtocol()

Member Function Documentation

◆ Add()

◆ GlobalCheck()

◆ NbResources()

◆ Resource()

◆ SchemaName()

◆ TypeNumber()