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

#include <APIHeaderSection_MakeHeader.hxx>

Public Member Functions
	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.

Detailed Description

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

Constructor & Destructor Documentation

◆ APIHeaderSection_MakeHeader() [1/2]

APIHeaderSection_MakeHeader::APIHeaderSection_MakeHeader ( const Standard_Integer shapetype = 0 )

Prepares a new MakeHeader from scratch.

◆ APIHeaderSection_MakeHeader() [2/2]

APIHeaderSection_MakeHeader::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.

Member Function Documentation

◆ AddSchemaIdentifier()

void APIHeaderSection_MakeHeader::AddSchemaIdentifier ( const Handle< TCollection_HAsciiString > & aSchemaIdentifier )

Add a subname of schema (if not yet in the list)

◆ Apply()

void APIHeaderSection_MakeHeader::Apply ( const Handle< StepData_StepModel > & model ) const

Creates an empty header for a new STEP model and allows the header fields to be completed.

◆ Author()

Handle< Interface_HArray1OfHAsciiString > APIHeaderSection_MakeHeader::Author ( ) const

◆ Authorisation()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::Authorisation ( ) const

Returns the value of the authorization attribute for the file_name entity.

◆ AuthorValue()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::AuthorValue ( const Standard_Integer num ) const

Returns the value of the name attribute for the file_name entity.

◆ Description()

Handle< Interface_HArray1OfHAsciiString > APIHeaderSection_MakeHeader::Description ( ) const

◆ DescriptionValue()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::DescriptionValue ( const Standard_Integer num ) const

Returns the value of the description attribute for the file_description entity.

◆ FdValue()

Handle< HeaderSection_FileDescription > APIHeaderSection_MakeHeader::FdValue ( ) const

Returns the file_description entity. Returns an empty entity if the file_description entity is not initialized.

◆ FnValue()

Handle< HeaderSection_FileName > APIHeaderSection_MakeHeader::FnValue ( ) const

Returns the file_name entity. Returns an empty entity if the file_name entity is not initialized.

◆ FsValue()

Handle< HeaderSection_FileSchema > APIHeaderSection_MakeHeader::FsValue ( ) const

Returns the file_schema entity. Returns an empty entity if the file_schema entity is not initialized.

◆ HasFd()

Standard_Boolean APIHeaderSection_MakeHeader::HasFd ( ) const

Checks whether there is a file_description entity. Returns True if there is one.

◆ HasFn()

Standard_Boolean APIHeaderSection_MakeHeader::HasFn ( ) const

Checks whether there is a file_name entity. Returns True if there is one.

◆ HasFs()

Standard_Boolean APIHeaderSection_MakeHeader::HasFs ( ) const

Checks whether there is a file_schema entity. Returns True if there is one.

◆ ImplementationLevel()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::ImplementationLevel ( ) const

Returns the value of the implementation_level attribute for the file_description entity.

◆ Init()

void APIHeaderSection_MakeHeader::Init ( const Standard_CString nameval )

Cancels the former definition and gives a FileName To be used when a Model has no well defined Header.

◆ IsDone()

Standard_Boolean APIHeaderSection_MakeHeader::IsDone ( ) const

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

◆ Name()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::Name ( ) const

Returns the name attribute for the file_name entity.

◆ NbAuthor()

Standard_Integer APIHeaderSection_MakeHeader::NbAuthor ( ) const

Returns the number of values for the author attribute in the file_name entity.

◆ NbDescription()

Standard_Integer APIHeaderSection_MakeHeader::NbDescription ( ) const

Returns the number of values for the file_description entity in the STEP file header.

◆ NbOrganization()

Standard_Integer APIHeaderSection_MakeHeader::NbOrganization ( ) const

Returns the number of values for the organization attribute in the file_name entity.

◆ NbSchemaIdentifiers()

Standard_Integer APIHeaderSection_MakeHeader::NbSchemaIdentifiers ( ) const

Returns the number of values for the schema_identifier attribute in the file_schema entity.

◆ NewModel()

Handle< StepData_StepModel > APIHeaderSection_MakeHeader::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)

◆ Organization()

Handle< Interface_HArray1OfHAsciiString > APIHeaderSection_MakeHeader::Organization ( ) const

◆ OrganizationValue()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::OrganizationValue ( const Standard_Integer num ) const

Returns the value of attribute organization for the file_name entity.

◆ OriginatingSystem()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::OriginatingSystem ( ) const

◆ PreprocessorVersion()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::PreprocessorVersion ( ) const

Returns the name of the preprocessor_version for the file_name entity.

◆ SchemaIdentifiers()

Handle< Interface_HArray1OfHAsciiString > APIHeaderSection_MakeHeader::SchemaIdentifiers ( ) const

◆ SchemaIdentifiersValue()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::SchemaIdentifiersValue ( const Standard_Integer num ) const

Returns the value of the schema_identifier attribute for the file_schema entity.

◆ SetAuthor()

void APIHeaderSection_MakeHeader::SetAuthor ( const Handle< Interface_HArray1OfHAsciiString > & aAuthor )

◆ SetAuthorisation()

void APIHeaderSection_MakeHeader::SetAuthorisation ( const Handle< TCollection_HAsciiString > & aAuthorisation )

◆ SetAuthorValue()

void APIHeaderSection_MakeHeader::SetAuthorValue	(	const Standard_Integer	num,
		const Handle< TCollection_HAsciiString > &	aAuthor
	)

◆ SetDescription()

void APIHeaderSection_MakeHeader::SetDescription ( const Handle< Interface_HArray1OfHAsciiString > & aDescription )

◆ SetDescriptionValue()

void APIHeaderSection_MakeHeader::SetDescriptionValue	(	const Standard_Integer	num,
		const Handle< TCollection_HAsciiString > &	aDescription
	)

◆ SetImplementationLevel()

void APIHeaderSection_MakeHeader::SetImplementationLevel ( const Handle< TCollection_HAsciiString > & aImplementationLevel )

◆ SetName()

void APIHeaderSection_MakeHeader::SetName ( const Handle< TCollection_HAsciiString > & aName )

◆ SetOrganization()

void APIHeaderSection_MakeHeader::SetOrganization ( const Handle< Interface_HArray1OfHAsciiString > & aOrganization )

◆ SetOrganizationValue()

void APIHeaderSection_MakeHeader::SetOrganizationValue	(	const Standard_Integer	num,
		const Handle< TCollection_HAsciiString > &	aOrganization
	)

◆ SetOriginatingSystem()

void APIHeaderSection_MakeHeader::SetOriginatingSystem ( const Handle< TCollection_HAsciiString > & aOriginatingSystem )

◆ SetPreprocessorVersion()

void APIHeaderSection_MakeHeader::SetPreprocessorVersion ( const Handle< TCollection_HAsciiString > & aPreprocessorVersion )

◆ SetSchemaIdentifiers()

void APIHeaderSection_MakeHeader::SetSchemaIdentifiers ( const Handle< Interface_HArray1OfHAsciiString > & aSchemaIdentifiers )

◆ SetSchemaIdentifiersValue()

void APIHeaderSection_MakeHeader::SetSchemaIdentifiersValue	(	const Standard_Integer	num,
		const Handle< TCollection_HAsciiString > &	aSchemaIdentifier
	)

◆ SetTimeStamp()

void APIHeaderSection_MakeHeader::SetTimeStamp ( const Handle< TCollection_HAsciiString > & aTimeStamp )

◆ TimeStamp()

Handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::TimeStamp ( ) const

Returns the value of the time_stamp attribute for the file_name entity.

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

APIHeaderSection_MakeHeader.hxx

Public Member Functions