APIHeaderSection_MakeHeader Class Reference

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 int shapetype=0)
	Prepares a new MakeHeader from scratch.
	APIHeaderSection_MakeHeader (const occ::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 char *const nameval)
	Cancels the former definition and gives a FileName To be used when a Model has no well defined Header.
bool	IsDone () const
	Returns True if all data have been defined (see also HasFn, HasFs, HasFd)
void	Apply (const occ::handle< StepData_StepModel > &model) const
	Creates an empty header for a new STEP model and allows the header fields to be completed.
occ::handle< StepData_StepModel >	NewModel (const occ::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)
bool	HasFn () const
	Checks whether there is a file_name entity. Returns True if there is one.
occ::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 occ::handle< TCollection_HAsciiString > &aName)
occ::handle< TCollection_HAsciiString >	Name () const
	Returns the name attribute for the file_name entity.
void	SetTimeStamp (const occ::handle< TCollection_HAsciiString > &aTimeStamp)
occ::handle< TCollection_HAsciiString >	TimeStamp () const
	Returns the value of the time_stamp attribute for the file_name entity.
void	SetAuthor (const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &aAuthor)
void	SetAuthorValue (const int num, const occ::handle< TCollection_HAsciiString > &aAuthor)
occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > >	Author () const
occ::handle< TCollection_HAsciiString >	AuthorValue (const int num) const
	Returns the value of the name attribute for the file_name entity.
int	NbAuthor () const
	Returns the number of values for the author attribute in the file_name entity.
void	SetOrganization (const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &aOrganization)
void	SetOrganizationValue (const int num, const occ::handle< TCollection_HAsciiString > &aOrganization)
occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > >	Organization () const
occ::handle< TCollection_HAsciiString >	OrganizationValue (const int num) const
	Returns the value of attribute organization for the file_name entity.
int	NbOrganization () const
	Returns the number of values for the organization attribute in the file_name entity.
void	SetPreprocessorVersion (const occ::handle< TCollection_HAsciiString > &aPreprocessorVersion)
occ::handle< TCollection_HAsciiString >	PreprocessorVersion () const
	Returns the name of the preprocessor_version for the file_name entity.
void	SetOriginatingSystem (const occ::handle< TCollection_HAsciiString > &aOriginatingSystem)
occ::handle< TCollection_HAsciiString >	OriginatingSystem () const
void	SetAuthorisation (const occ::handle< TCollection_HAsciiString > &aAuthorisation)
occ::handle< TCollection_HAsciiString >	Authorisation () const
	Returns the value of the authorization attribute for the file_name entity.
bool	HasFs () const
	Checks whether there is a file_schema entity. Returns True if there is one.
occ::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 occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &aSchemaIdentifiers)
void	SetSchemaIdentifiersValue (const int num, const occ::handle< TCollection_HAsciiString > &aSchemaIdentifier)
occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > >	SchemaIdentifiers () const
occ::handle< TCollection_HAsciiString >	SchemaIdentifiersValue (const int num) const
	Returns the value of the schema_identifier attribute for the file_schema entity.
int	NbSchemaIdentifiers () const
	Returns the number of values for the schema_identifier attribute in the file_schema entity.
void	AddSchemaIdentifier (const occ::handle< TCollection_HAsciiString > &aSchemaIdentifier)
	Add a subname of schema (if not yet in the list)
bool	HasFd () const
	Checks whether there is a file_description entity. Returns True if there is one.
occ::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 occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &aDescription)
void	SetDescriptionValue (const int num, const occ::handle< TCollection_HAsciiString > &aDescription)
occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > >	Description () const
occ::handle< TCollection_HAsciiString >	DescriptionValue (const int num) const
	Returns the value of the description attribute for the file_description entity.
int	NbDescription () const
	Returns the number of values for the file_description entity in the STEP file header.
void	SetImplementationLevel (const occ::handle< TCollection_HAsciiString > &aImplementationLevel)
occ::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 int

shapetype = 0

)

Prepares a new MakeHeader from scratch.

APIHeaderSection_MakeHeader() [2/2]

APIHeaderSection_MakeHeader::APIHeaderSection_MakeHeader

(

const occ::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 occ::handle< TCollection_HAsciiString > &

aSchemaIdentifier

)

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

Apply()

void APIHeaderSection_MakeHeader::Apply

(

const occ::handle< StepData_StepModel > &

model

)

const

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

Author()

occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > APIHeaderSection_MakeHeader::Author

(

)

const

Authorisation()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::Authorisation

(

)

const

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

AuthorValue()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::AuthorValue

(

const int

num

)

const

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

Description()

occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > APIHeaderSection_MakeHeader::Description

(

)

const

DescriptionValue()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::DescriptionValue

(

const int

num

)

const

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

FdValue()

occ::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()

occ::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()

occ::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()

bool APIHeaderSection_MakeHeader::HasFd

(

)

const

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

HasFn()

bool APIHeaderSection_MakeHeader::HasFn

(

)

const

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

HasFs()

bool APIHeaderSection_MakeHeader::HasFs

(

)

const

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

ImplementationLevel()

occ::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 char *const

nameval

)

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

IsDone()

bool APIHeaderSection_MakeHeader::IsDone

(

)

const

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

Name()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::Name

(

)

const

Returns the name attribute for the file_name entity.

NbAuthor()

int APIHeaderSection_MakeHeader::NbAuthor

(

)

const

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

NbDescription()

int APIHeaderSection_MakeHeader::NbDescription

(

)

const

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

NbOrganization()

int APIHeaderSection_MakeHeader::NbOrganization

(

)

const

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

NbSchemaIdentifiers()

int APIHeaderSection_MakeHeader::NbSchemaIdentifiers

(

)

const

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

NewModel()

occ::handle< StepData_StepModel > APIHeaderSection_MakeHeader::NewModel

(

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

occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > APIHeaderSection_MakeHeader::Organization

(

)

const

OrganizationValue()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::OrganizationValue

(

const int

num

)

const

Returns the value of attribute organization for the file_name entity.

OriginatingSystem()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::OriginatingSystem

(

)

const

PreprocessorVersion()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::PreprocessorVersion

(

)

const

Returns the name of the preprocessor_version for the file_name entity.

SchemaIdentifiers()

occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > APIHeaderSection_MakeHeader::SchemaIdentifiers

(

)

const

SchemaIdentifiersValue()

occ::handle< TCollection_HAsciiString > APIHeaderSection_MakeHeader::SchemaIdentifiersValue

(

const int

num

)

const

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

SetAuthor()

void APIHeaderSection_MakeHeader::SetAuthor

(

const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &

aAuthor

)

SetAuthorisation()

void APIHeaderSection_MakeHeader::SetAuthorisation

(

const occ::handle< TCollection_HAsciiString > &

aAuthorisation

)

SetAuthorValue()

void APIHeaderSection_MakeHeader::SetAuthorValue	(	const int	num,
		const occ::handle< TCollection_HAsciiString > &	aAuthor )

SetDescription()

void APIHeaderSection_MakeHeader::SetDescription

(

const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &

aDescription

)

SetDescriptionValue()

void APIHeaderSection_MakeHeader::SetDescriptionValue	(	const int	num,
		const occ::handle< TCollection_HAsciiString > &	aDescription )

SetImplementationLevel()

void APIHeaderSection_MakeHeader::SetImplementationLevel

(

const occ::handle< TCollection_HAsciiString > &

aImplementationLevel

)

SetName()

void APIHeaderSection_MakeHeader::SetName

(

const occ::handle< TCollection_HAsciiString > &

aName

)

SetOrganization()

void APIHeaderSection_MakeHeader::SetOrganization

(

const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &

aOrganization

)

SetOrganizationValue()

void APIHeaderSection_MakeHeader::SetOrganizationValue	(	const int	num,
		const occ::handle< TCollection_HAsciiString > &	aOrganization )

SetOriginatingSystem()

void APIHeaderSection_MakeHeader::SetOriginatingSystem

(

const occ::handle< TCollection_HAsciiString > &

aOriginatingSystem

)

SetPreprocessorVersion()

void APIHeaderSection_MakeHeader::SetPreprocessorVersion

(

const occ::handle< TCollection_HAsciiString > &

aPreprocessorVersion

)

SetSchemaIdentifiers()

void APIHeaderSection_MakeHeader::SetSchemaIdentifiers

(

const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &

aSchemaIdentifiers

)

SetSchemaIdentifiersValue()

void APIHeaderSection_MakeHeader::SetSchemaIdentifiersValue	(	const int	num,
		const occ::handle< TCollection_HAsciiString > &	aSchemaIdentifier )

SetTimeStamp()

void APIHeaderSection_MakeHeader::SetTimeStamp

(

const occ::handle< TCollection_HAsciiString > &

aTimeStamp

)

TimeStamp()

occ::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