Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
StepData_HeaderTool Class Reference

HeaderTool exploits data from Header to build a Protocol :
it uses the Header Entity FileSchema to do this.
It builds a Protocol from the Global List of Protocols
stored in the Library ReaderLib

#include <StepData_HeaderTool.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC StepData_HeaderTool (const Handle< StepData_StepReaderData > &data)
 Creates a HeaderTool from data read from a File. Computes the
list of Schema Names. The Protocol will be computed later
(because there are several options)

 StepData_HeaderTool (const TColStd_SequenceOfAsciiString &names)
 Creates a HeaderTool directly from a list of Schema Names

Standard_Integer NbSchemaNames () const
 Returns the count of SchemaNames

const TCollection_AsciiStringSchemaName (const Standard_Integer num) const
 Returns a SchemaName, given its rank

Handle_StepData_Protocol NamedProtocol (const TCollection_AsciiString &name) const
 Returns the Protocol which corresponds to a Schema Name
Returns a Null Handle if this Schema Name is attached to no
Protocol recorded in the Global List of ReaderLib

void Build (const Handle< StepData_FileProtocol > &protocol)
 Fills a FileProtocol with the list of Protocols attached to
the list of Schema Names. It can remain empty ...

Handle_StepData_Protocol Protocol ()
 Returns a Protocol computed from the list of Schema Names :

Standard_Boolean IsDone () const
 Returns True if either Build or Protocol has been called
If it is False, Ignored and NbIgnored should not be called

Standard_Integer NbIgnoreds () const
 Returns the count of ignored SchemaNames (0 if all were OK)

const TCollection_AsciiStringIgnored (const Standard_Integer num) const
 Returns an ignored SchemaName, given its rank in the list of
Ignored SchemaNames (not in the total list)

void Print (Standard_OStream &S) const
 Sends the state of the HeaderTool in a comprehensive way,
to an output stream


Constructor & Destructor Documentation


Member Function Documentation

Handle_StepData_Protocol StepData_HeaderTool::NamedProtocol ( const TCollection_AsciiString name) const
Handle_StepData_Protocol StepData_HeaderTool::Protocol ( )
  • a Null Handle if no SchemaName has been recognized (or list
    empty)
  • a single Protocol if only one SchemaName has been recognized
  • a FileProtocol with its componants if several SchemaNames
    have been recognized

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