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

This class allows to consult and prepare/edit data stored in
a Step Model Header

#include <APIHeaderSection_MakeHeader.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC APIHeaderSection_MakeHeader (const Standard_Integer shapetype=0)
 Prepares a new MakeHeader from scratch

 APIHeaderSection_MakeHeader (const Handle< StepData_StepModel > &model)
 Prepares a MakeHeader from the content of a StepModel
See IsDone to know if the Header is well defined

void Init (const Standard_CString nameval)
 Cancels the former definition and gives a FileName
To be used when a Model has no well defined Header

Standard_Boolean IsDone () const
 Returns True if all data have been defined (see also
HasFn, HasFs, HasFd)

void Apply (const Handle< StepData_StepModel > &model) const
 Creates an empty header for a new
STEP model and allows the header fields to be completed.

Handle_StepData_StepModel NewModel (const Handle< Interface_Protocol > &protocol) const
 Builds a Header, creates a new StepModel, then applies the
Header to the StepModel
The Schema Name is taken from the Protocol (if it inherits
from StepData, else it is left in blanks)

Standard_Boolean HasFn () const
 Checks whether there is a
file_name entity. Returns True if there is one.

Handle_HeaderSection_FileName FnValue () const
 Returns the file_name entity.
Returns an empty entity if the file_name entity is not initialized.

void SetName (const Handle< TCollection_HAsciiString > &aName)
Handle_TCollection_HAsciiString Name () const
 Returns the name attribute for the file_name entity.

void SetTimeStamp (const Handle< TCollection_HAsciiString > &aTimeStamp)
Handle_TCollection_HAsciiString TimeStamp () const
 Returns the value of the time_stamp attribute for the file_name entity.

void SetAuthor (const Handle< Interface_HArray1OfHAsciiString > &aAuthor)
void SetAuthorValue (const Standard_Integer num, const Handle< TCollection_HAsciiString > &aAuthor)
Handle_Interface_HArray1OfHAsciiString Author () const
Handle_TCollection_HAsciiString AuthorValue (const Standard_Integer num) const
 Returns the value of the name attribute for the file_name entity.

Standard_Integer NbAuthor () const
 Returns the number of values for the author attribute in the file_name entity.

void SetOrganization (const Handle< Interface_HArray1OfHAsciiString > &aOrganization)
void SetOrganizationValue (const Standard_Integer num, const Handle< TCollection_HAsciiString > &aOrganization)
Handle_Interface_HArray1OfHAsciiString Organization () const
Handle_TCollection_HAsciiString OrganizationValue (const Standard_Integer num) const
 Returns the value of attribute
organization for the file_name entity.

Standard_Integer NbOrganization () const
 Returns the number of values for
the organization attribute in the file_name entity.

void SetPreprocessorVersion (const Handle< TCollection_HAsciiString > &aPreprocessorVersion)
Handle_TCollection_HAsciiString PreprocessorVersion () const
 Returns the name of the preprocessor_version for the file_name entity.

void SetOriginatingSystem (const Handle< TCollection_HAsciiString > &aOriginatingSystem)
Handle_TCollection_HAsciiString OriginatingSystem () const
void SetAuthorisation (const Handle< TCollection_HAsciiString > &aAuthorisation)
Handle_TCollection_HAsciiString Authorisation () const
 Returns the value of the authorization attribute for the file_name entity.

Standard_Boolean HasFs () const
 Checks whether there is a file_schema entity. Returns True if there is one.

Handle_HeaderSection_FileSchema FsValue () const
 Returns the file_schema entity. Returns an empty entity if the file_schema entity is not initialized.

void SetSchemaIdentifiers (const Handle< Interface_HArray1OfHAsciiString > &aSchemaIdentifiers)
void SetSchemaIdentifiersValue (const Standard_Integer num, const Handle< TCollection_HAsciiString > &aSchemaIdentifier)
Handle_Interface_HArray1OfHAsciiString SchemaIdentifiers () const
Handle_TCollection_HAsciiString SchemaIdentifiersValue (const Standard_Integer num) const
 Returns the value of the schema_identifier attribute for the file_schema entity.

Standard_Integer NbSchemaIdentifiers () const
 Returns the number of values for the schema_identifier attribute in the file_schema entity.

void AddSchemaIdentifier (const Handle< TCollection_HAsciiString > &aSchemaIdentifier)
 Add a subname of schema (if not yet in the list)

Standard_Boolean HasFd () const
 Checks whether there is a file_description entity. Returns True if there is one.

Handle_HeaderSection_FileDescription FdValue () const
 Returns the file_description
entity. Returns an empty entity if the file_description entity is not initialized.

void SetDescription (const Handle< Interface_HArray1OfHAsciiString > &aDescription)
void SetDescriptionValue (const Standard_Integer num, const Handle< TCollection_HAsciiString > &aDescription)
Handle_Interface_HArray1OfHAsciiString Description () const
Handle_TCollection_HAsciiString DescriptionValue (const Standard_Integer num) const
 Returns the value of the
description attribute for the file_description entity.

Standard_Integer NbDescription () const
 Returns the number of values for
the file_description entity in the STEP file header.

void SetImplementationLevel (const Handle< TCollection_HAsciiString > &aImplementationLevel)
Handle_TCollection_HAsciiString ImplementationLevel () const
 Returns the value of the
implementation_level attribute for the file_description entity.


Constructor & Destructor Documentation


Member Function Documentation

Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::Author ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::Authorisation ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::AuthorValue ( const Standard_Integer  num) const
Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::Description ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::DescriptionValue ( const Standard_Integer  num) const
Handle_HeaderSection_FileDescription APIHeaderSection_MakeHeader::FdValue ( ) const
Handle_HeaderSection_FileName APIHeaderSection_MakeHeader::FnValue ( ) const
Handle_HeaderSection_FileSchema APIHeaderSection_MakeHeader::FsValue ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::ImplementationLevel ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::Name ( ) const
Handle_StepData_StepModel APIHeaderSection_MakeHeader::NewModel ( const Handle< Interface_Protocol > &  protocol) const
Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::Organization ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::OrganizationValue ( const Standard_Integer  num) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::OriginatingSystem ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::PreprocessorVersion ( ) const
Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::SchemaIdentifiers ( ) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::SchemaIdentifiersValue ( const Standard_Integer  num) const
Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::TimeStamp ( ) const

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