OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# DataExchange
TKXSBase
APIHeaderSection

# 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
void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | APIHeaderSection_MakeHeader (const Standard_Integer shapetype=0)
| Prepares a new MakeHeader from scratch .
Standard_EXPORT | 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 .
Standard_EXPORT 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_EXPORT Standard_Boolean | IsDone () const
| Returns True if all data have been defined (see also HasFn, HasFs, HasFd) .
Standard_EXPORT 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. .
Standard_EXPORT 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_EXPORT Standard_Boolean | HasFn () const
| Checks whether there is a file_name entity. Returns True if there is one. .
Standard_EXPORT Handle_HeaderSection_FileName | FnValue () const
| Returns the file_name entity. Returns an empty entity if the file_name entity is not initialized. .
Standard_EXPORT void | SetName (const Handle(TCollection_HAsciiString)&aName)
Standard_EXPORT Handle_TCollection_HAsciiString | Name () const
| Returns the name attribute for the file_name entity. .
Standard_EXPORT void | SetTimeStamp (const Handle(TCollection_HAsciiString)&aTimeStamp)
Standard_EXPORT Handle_TCollection_HAsciiString | TimeStamp () const
| Returns the value of the time_stamp attribute for the file_name entity. .
Standard_EXPORT void | SetAuthor (const Handle(Interface_HArray1OfHAsciiString)&aAuthor)
Standard_EXPORT void | SetAuthorValue (const Standard_Integer num, const Handle(TCollection_HAsciiString)&aAuthor)
Standard_EXPORT Handle_Interface_HArray1OfHAsciiString | Author () const
Standard_EXPORT Handle_TCollection_HAsciiString | AuthorValue (const Standard_Integer num) const
| Returns the value of the name attribute for the file_name entity. .
Standard_EXPORT Standard_Integer | NbAuthor () const
| Returns the number of values for the author attribute in the file_name entity. .
Standard_EXPORT void | SetOrganization (const Handle(Interface_HArray1OfHAsciiString)&aOrganization)
Standard_EXPORT void | SetOrganizationValue (const Standard_Integer num, const Handle(TCollection_HAsciiString)&aOrganization)
Standard_EXPORT Handle_Interface_HArray1OfHAsciiString | Organization () const
Standard_EXPORT Handle_TCollection_HAsciiString | OrganizationValue (const Standard_Integer num) const
| Returns the value of attribute organization for the file_name entity. .
Standard_EXPORT Standard_Integer | NbOrganization () const
| Returns the number of values for the organization attribute in the file_name entity. .
Standard_EXPORT void | SetPreprocessorVersion (const Handle(TCollection_HAsciiString)&aPreprocessorVersion)
Standard_EXPORT Handle_TCollection_HAsciiString | PreprocessorVersion () const
| Returns the name of the preprocessor_version for the file_name entity. .
Standard_EXPORT void | SetOriginatingSystem (const Handle(TCollection_HAsciiString)&aOriginatingSystem)
Standard_EXPORT Handle_TCollection_HAsciiString | OriginatingSystem () const
Standard_EXPORT void | SetAuthorisation (const Handle(TCollection_HAsciiString)&aAuthorisation)
Standard_EXPORT Handle_TCollection_HAsciiString | Authorisation () const
| Returns the value of the authorization attribute for the file_name entity. .
Standard_EXPORT Standard_Boolean | HasFs () const
| Checks whether there is a file_schema entity. Returns True if there is one. .
Standard_EXPORT Handle_HeaderSection_FileSchema | FsValue () const
| Returns the file_schema entity. Returns an empty entity if the file_schema entity is not initialized. .
Standard_EXPORT void | SetSchemaIdentifiers (const Handle(Interface_HArray1OfHAsciiString)&aSchemaIdentifiers)
Standard_EXPORT void | SetSchemaIdentifiersValue (const Standard_Integer num, const Handle(TCollection_HAsciiString)&aSchemaIdentifier)
Standard_EXPORT Handle_Interface_HArray1OfHAsciiString | SchemaIdentifiers () const
Standard_EXPORT Handle_TCollection_HAsciiString | SchemaIdentifiersValue (const Standard_Integer num) const
| Returns the value of the schema_identifier attribute for the file_schema entity. .
Standard_EXPORT Standard_Integer | NbSchemaIdentifiers () const
| Returns the number of values for the schema_identifier attribute in the file_schema entity. .
Standard_EXPORT void | AddSchemaIdentifier (const Handle(TCollection_HAsciiString)&aSchemaIdentifier)
| Add a subname of schema (if not yet in the list) .
Standard_EXPORT Standard_Boolean | HasFd () const
| Checks whether there is a file_description entity. Returns True if there is one. .
Standard_EXPORT Handle_HeaderSection_FileDescription | FdValue () const
| Returns the file_description entity. Returns an empty entity if the file_description entity is not initialized. .
Standard_EXPORT void | SetDescription (const Handle(Interface_HArray1OfHAsciiString)&aDescription)
Standard_EXPORT void | SetDescriptionValue (const Standard_Integer num, const Handle(TCollection_HAsciiString)&aDescription)
Standard_EXPORT Handle_Interface_HArray1OfHAsciiString | Description () const
Standard_EXPORT Handle_TCollection_HAsciiString | DescriptionValue (const Standard_Integer num) const
| Returns the value of the description attribute for the file_description entity. .
Standard_EXPORT Standard_Integer | NbDescription () const
| Returns the number of values for the file_description entity in the STEP file header. .
Standard_EXPORT void | SetImplementationLevel (const Handle(TCollection_HAsciiString)&aImplementationLevel)
Standard_EXPORT Handle_TCollection_HAsciiString | ImplementationLevel () const
| Returns the value of the implementation_level attribute for the file_description entity. .
## Private Attributes
Standard_Boolean | done
Handle_HeaderSection_FileName | fn
Handle_HeaderSection_FileSchema | fs
Handle_HeaderSection_FileDescription | fd

## Constructor & Destructor Documentation

Standard_EXPORT APIHeaderSection_MakeHeader::APIHeaderSection_MakeHeader | ( | const Standard_Integer | shapetype = `0` | ) |

Standard_EXPORT APIHeaderSection_MakeHeader::APIHeaderSection_MakeHeader | ( | const Handle(StepData_StepModel)& | model | ) |

## Member Function Documentation

Standard_EXPORT void APIHeaderSection_MakeHeader::AddSchemaIdentifier | ( | const Handle(TCollection_HAsciiString)& | aSchemaIdentifier | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::Apply | ( | const Handle(StepData_StepModel)& | model | ) | const

Standard_EXPORT Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::Author | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::Authorisation | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::AuthorValue | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::Description | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::DescriptionValue | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Handle_HeaderSection_FileDescription APIHeaderSection_MakeHeader::FdValue | ( |  | ) | const

Standard_EXPORT Handle_HeaderSection_FileName APIHeaderSection_MakeHeader::FnValue | ( |  | ) | const

Standard_EXPORT Handle_HeaderSection_FileSchema APIHeaderSection_MakeHeader::FsValue | ( |  | ) | const

Standard_EXPORT Standard_Boolean APIHeaderSection_MakeHeader::HasFd | ( |  | ) | const

Standard_EXPORT Standard_Boolean APIHeaderSection_MakeHeader::HasFn | ( |  | ) | const

Standard_EXPORT Standard_Boolean APIHeaderSection_MakeHeader::HasFs | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::ImplementationLevel | ( |  | ) | const

Standard_EXPORT void APIHeaderSection_MakeHeader::Init | ( | const Standard_CString | nameval | ) |

Standard_EXPORT Standard_Boolean APIHeaderSection_MakeHeader::IsDone | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::Name | ( |  | ) | const

Standard_EXPORT Standard_Integer APIHeaderSection_MakeHeader::NbAuthor | ( |  | ) | const

Standard_EXPORT Standard_Integer APIHeaderSection_MakeHeader::NbDescription | ( |  | ) | const

Standard_EXPORT Standard_Integer APIHeaderSection_MakeHeader::NbOrganization | ( |  | ) | const

Standard_EXPORT Standard_Integer APIHeaderSection_MakeHeader::NbSchemaIdentifiers | ( |  | ) | const

Standard_EXPORT Handle_StepData_StepModel APIHeaderSection_MakeHeader::NewModel | ( | const Handle(Interface_Protocol)& | protocol | ) | const

void APIHeaderSection_MakeHeader::operator delete | ( | void * | anAddress | ) | `[inline]`

void* APIHeaderSection_MakeHeader::operator new | ( | size_t | size | ) | `[inline]`

void* APIHeaderSection_MakeHeader::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Standard_EXPORT Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::Organization | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::OrganizationValue | ( | const Standard_Integer | num | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::OriginatingSystem | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::PreprocessorVersion | ( |  | ) | const

Standard_EXPORT Handle_Interface_HArray1OfHAsciiString APIHeaderSection_MakeHeader::SchemaIdentifiers | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::SchemaIdentifiersValue | ( | const Standard_Integer | num | ) | const

Standard_EXPORT void APIHeaderSection_MakeHeader::SetAuthor | ( | const Handle(Interface_HArray1OfHAsciiString)& | aAuthor | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetAuthorisation | ( | const Handle(TCollection_HAsciiString)& | aAuthorisation | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetAuthorValue | ( | const Standard_Integer | num,
|  | const Handle(TCollection_HAsciiString)& | aAuthor
| ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetDescription | ( | const Handle(Interface_HArray1OfHAsciiString)& | aDescription | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetDescriptionValue | ( | const Standard_Integer | num,
|  | const Handle(TCollection_HAsciiString)& | aDescription
| ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetImplementationLevel | ( | const Handle(TCollection_HAsciiString)& | aImplementationLevel | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetName | ( | const Handle(TCollection_HAsciiString)& | aName | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetOrganization | ( | const Handle(Interface_HArray1OfHAsciiString)& | aOrganization | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetOrganizationValue | ( | const Standard_Integer | num,
|  | const Handle(TCollection_HAsciiString)& | aOrganization
| ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetOriginatingSystem | ( | const Handle(TCollection_HAsciiString)& | aOriginatingSystem | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetPreprocessorVersion | ( | const Handle(TCollection_HAsciiString)& | aPreprocessorVersion | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetSchemaIdentifiers | ( | const Handle(Interface_HArray1OfHAsciiString)& | aSchemaIdentifiers | ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetSchemaIdentifiersValue | ( | const Standard_Integer | num,
|  | const Handle(TCollection_HAsciiString)& | aSchemaIdentifier
| ) |

Standard_EXPORT void APIHeaderSection_MakeHeader::SetTimeStamp | ( | const Handle(TCollection_HAsciiString)& | aTimeStamp | ) |

Standard_EXPORT Handle_TCollection_HAsciiString APIHeaderSection_MakeHeader::TimeStamp | ( |  | ) | const

## Field Documentation

Standard_Boolean APIHeaderSection_MakeHeader::done`[private]`

Handle_HeaderSection_FileDescription APIHeaderSection_MakeHeader::fd`[private]`

Handle_HeaderSection_FileName APIHeaderSection_MakeHeader::fn`[private]`

Handle_HeaderSection_FileSchema APIHeaderSection_MakeHeader::fs`[private]`

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

- APIHeaderSection_MakeHeader.hxx