Description of a global section (corresponds to file header) used as well in IGESModel, IGESReader and IGESWriter Warning : From IGES-5.1, a parameter is added : LastChangeDate (concerns transferred set of data, not the file itself) Of course, it can be absent if read from earlier versions (a default is then to be set to current date) From 5.3, one more : ApplicationProtocol (optional) More...

#include <IGESData_GlobalSection.hxx>

Public Member Functions
	IGESData_GlobalSection ()
	Creates an empty GlobalSection, ready to be filled, Warning : No default value is provided.

void	Init (const occ::handle< Interface_ParamSet > &params, occ::handle< Interface_Check > &ach)
	Fills GlobalSection from a ParamSet (i.e. taken from file) undefined parameters do not change default values when defined Fills Check about Corrections or Fails.

void	CopyRefs ()
	Copies data referenced by Handle (that is, Strings) useful to "isolate" a GlobalSection after copy by "=" (from a Model to another Model for instance)

occ::handle< Interface_ParamSet >	Params () const
	Returns all contained data in the form of a ParamSet Remark : Strings are given under Hollerith form.

occ::handle< TCollection_HAsciiString >	TranslatedFromHollerith (const occ::handle< TCollection_HAsciiString > &astr) const
	Returns a string withpout its Hollerith marks (nnnH ahead). Remark : all strings stored in GlobalSection are expurged from Hollerith information (without nnnH) If <astr> is not Hollerith form, it is simply copied.

char	Separator () const
	Returns the parameter delimiter character.

char	EndMark () const
	Returns the record delimiter character.

occ::handle< TCollection_HAsciiString >	SendName () const
	Returns the name of the sending system.

occ::handle< TCollection_HAsciiString >	FileName () const
	Returns the name of the IGES file.

occ::handle< TCollection_HAsciiString >	SystemId () const
	Returns the Native System ID of the system that created the IGES file.

occ::handle< TCollection_HAsciiString >	InterfaceVersion () const
	Returns the name of the pre-processor used to write the IGES file.

int	IntegerBits () const
	Returns the number of binary bits for integer representations.

int	MaxPower10Single () const
	Returns the maximum power of a decimal representation of a single-precision floating point number in the sending system.

int	MaxDigitsSingle () const

int	MaxPower10Double () const
	Returns the maximum power of a decimal representation of a double-precision floating point number in the sending system.

int	MaxDigitsDouble () const

occ::handle< TCollection_HAsciiString >	ReceiveName () const
	Returns the name of the receiving system.

double	Scale () const
	Returns the scale used in the IGES file.

double	CascadeUnit () const
	Returns the system length unit.

int	UnitFlag () const
	Returns the unit flag that was used to write the IGES file.

occ::handle< TCollection_HAsciiString >	UnitName () const
	Returns the name of the unit the IGES file was written in.

int	LineWeightGrad () const
	Returns the maximum number of line weight gradations.

double	MaxLineWeight () const
	Returns the of maximum line weight width in IGES file units.

occ::handle< TCollection_HAsciiString >	Date () const
	Returns the IGES file creation date.

double	Resolution () const
	Returns the resolution used in the IGES file.

double	MaxCoord () const
	Returns the approximate maximum coordinate value found in the model.

bool	HasMaxCoord () const
	Returns True if the approximate maximum coordinate value found in the model is greater than 0.

occ::handle< TCollection_HAsciiString >	AuthorName () const
	Returns the name of the IGES file author.

occ::handle< TCollection_HAsciiString >	CompanyName () const
	Returns the name of the company where the IGES file was written.

int	IGESVersion () const
	Returns the IGES version that the IGES file was written in.

int	DraftingStandard () const

occ::handle< TCollection_HAsciiString >	LastChangeDate () const
	Returns the date and time when the model was created or last modified (for IGES 5.1 and later).

bool	HasLastChangeDate () const
	Returns True if the date and time when the model was created or last modified are specified, i.e. not defaulted to NULL.

void	SetLastChangeDate ()

occ::handle< TCollection_HAsciiString >	ApplicationProtocol () const

bool	HasApplicationProtocol () const

double	UnitValue () const
	Returns the unit value (in meters) that the IGES file was written in.

void	SetSeparator (const char val)

void	SetEndMark (const char val)

void	SetSendName (const occ::handle< TCollection_HAsciiString > &val)

void	SetFileName (const occ::handle< TCollection_HAsciiString > &val)

void	SetSystemId (const occ::handle< TCollection_HAsciiString > &val)

void	SetInterfaceVersion (const occ::handle< TCollection_HAsciiString > &val)

void	SetIntegerBits (const int val)

void	SetMaxPower10Single (const int val)

void	SetMaxDigitsSingle (const int val)

void	SetMaxPower10Double (const int val)

void	SetMaxDigitsDouble (const int val)

void	SetReceiveName (const occ::handle< TCollection_HAsciiString > &val)

void	SetCascadeUnit (const double theUnit)

void	SetScale (const double val)

void	SetUnitFlag (const int val)

void	SetUnitName (const occ::handle< TCollection_HAsciiString > &val)

void	SetLineWeightGrad (const int val)

void	SetMaxLineWeight (const double val)

void	SetDate (const occ::handle< TCollection_HAsciiString > &val)

void	SetResolution (const double val)

void	SetMaxCoord (const double val=0.0)

void	MaxMaxCoord (const double val=0.0)

void	MaxMaxCoords (const gp_XYZ &xyz)

void	SetAuthorName (const occ::handle< TCollection_HAsciiString > &val)

void	SetCompanyName (const occ::handle< TCollection_HAsciiString > &val)

void	SetIGESVersion (const int val)

void	SetDraftingStandard (const int val)

void	SetLastChangeDate (const occ::handle< TCollection_HAsciiString > &val)

void	SetApplicationProtocol (const occ::handle< TCollection_HAsciiString > &val)

Static Public Member Functions
static occ::handle< TCollection_HAsciiString >	NewDateString (const int year, const int month, const int day, const int hour, const int minut, const int second, const int mode=-1)
	Returns a string built from year, month, day, hour, minute and second values. The form of the resulting string is defined as follows:

static occ::handle< TCollection_HAsciiString >	NewDateString (const occ::handle< TCollection_HAsciiString > &date, const int mode=1)
	Converts the string given in the form YYMMDD.HHNNSS or YYYYMMDD.HHNNSS to either YYMMDD.HHNNSS, YYYYMMDD.HHNNSS or YYYY-MM-DD:HH-NN-SS.

Detailed Description

Description of a global section (corresponds to file header) used as well in IGESModel, IGESReader and IGESWriter Warning : From IGES-5.1, a parameter is added : LastChangeDate (concerns transferred set of data, not the file itself) Of course, it can be absent if read from earlier versions (a default is then to be set to current date) From 5.3, one more : ApplicationProtocol (optional)

Constructor & Destructor Documentation

◆ IGESData_GlobalSection()

IGESData_GlobalSection::IGESData_GlobalSection ( )

Creates an empty GlobalSection, ready to be filled, Warning : No default value is provided.

Member Function Documentation

◆ ApplicationProtocol()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::ApplicationProtocol ( ) const

◆ AuthorName()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::AuthorName ( ) const

Returns the name of the IGES file author.

◆ CascadeUnit()

double IGESData_GlobalSection::CascadeUnit ( ) const

Returns the system length unit.

◆ CompanyName()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::CompanyName ( ) const

Returns the name of the company where the IGES file was written.

◆ CopyRefs()

void IGESData_GlobalSection::CopyRefs ( )

Copies data referenced by Handle (that is, Strings) useful to "isolate" a GlobalSection after copy by "=" (from a Model to another Model for instance)

◆ Date()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::Date ( ) const

Returns the IGES file creation date.

◆ DraftingStandard()

int IGESData_GlobalSection::DraftingStandard ( ) const

◆ EndMark()

char IGESData_GlobalSection::EndMark ( ) const

Returns the record delimiter character.

◆ FileName()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::FileName ( ) const

Returns the name of the IGES file.

◆ HasApplicationProtocol()

bool IGESData_GlobalSection::HasApplicationProtocol ( ) const

◆ HasLastChangeDate()

bool IGESData_GlobalSection::HasLastChangeDate ( ) const

Returns True if the date and time when the model was created or last modified are specified, i.e. not defaulted to NULL.

◆ HasMaxCoord()

bool IGESData_GlobalSection::HasMaxCoord ( ) const

Returns True if the approximate maximum coordinate value found in the model is greater than 0.

◆ IGESVersion()

int IGESData_GlobalSection::IGESVersion ( ) const

Returns the IGES version that the IGES file was written in.

◆ Init()

void IGESData_GlobalSection::Init	(	const occ::handle< Interface_ParamSet > &	params,
		occ::handle< Interface_Check > &	ach )

Fills GlobalSection from a ParamSet (i.e. taken from file) undefined parameters do not change default values when defined Fills Check about Corrections or Fails.

◆ IntegerBits()

int IGESData_GlobalSection::IntegerBits ( ) const

Returns the number of binary bits for integer representations.

◆ InterfaceVersion()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::InterfaceVersion ( ) const

Returns the name of the pre-processor used to write the IGES file.

◆ LastChangeDate()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::LastChangeDate ( ) const

Returns the date and time when the model was created or last modified (for IGES 5.1 and later).

◆ LineWeightGrad()

int IGESData_GlobalSection::LineWeightGrad ( ) const

Returns the maximum number of line weight gradations.

◆ MaxCoord()

double IGESData_GlobalSection::MaxCoord ( ) const

Returns the approximate maximum coordinate value found in the model.

◆ MaxDigitsDouble()

int IGESData_GlobalSection::MaxDigitsDouble ( ) const

◆ MaxDigitsSingle()

int IGESData_GlobalSection::MaxDigitsSingle ( ) const

◆ MaxLineWeight()

double IGESData_GlobalSection::MaxLineWeight ( ) const

Returns the of maximum line weight width in IGES file units.

◆ MaxMaxCoord()

void IGESData_GlobalSection::MaxMaxCoord ( const double val = 0.0 )

◆ MaxMaxCoords()

void IGESData_GlobalSection::MaxMaxCoords ( const gp_XYZ & xyz )

◆ MaxPower10Double()

int IGESData_GlobalSection::MaxPower10Double ( ) const

Returns the maximum power of a decimal representation of a double-precision floating point number in the sending system.

◆ MaxPower10Single()

int IGESData_GlobalSection::MaxPower10Single ( ) const

Returns the maximum power of a decimal representation of a single-precision floating point number in the sending system.

◆ NewDateString() [1/2]

static occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::NewDateString	(	const int	year,
		const int	month,
		const int	day,
		const int	hour,
		const int	minut,
		const int	second,
		const int	mode = -1 )

static

Returns a string built from year, month, day, hour, minute and second values. The form of the resulting string is defined as follows:

-1: YYMMDD.HHNNSS,
0: YYYYMMDD.HHNNSS,
1: YYYY-MM-DD:HH-NN-SS, where:
YYYY or YY is 4 or 2 digit year,
HH is hour (00-23),
MM is month (01-12),
NN is minute (00-59)
DD is day (01-31),
SS is second (00-59).

◆ NewDateString() [2/2]

static occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::NewDateString	(	const occ::handle< TCollection_HAsciiString > &	date,
		const int	mode = 1 )

static

Converts the string given in the form YYMMDD.HHNNSS or YYYYMMDD.HHNNSS to either YYMMDD.HHNNSS, YYYYMMDD.HHNNSS or YYYY-MM-DD:HH-NN-SS.

◆ Params()

occ::handle< Interface_ParamSet > IGESData_GlobalSection::Params ( ) const

Returns all contained data in the form of a ParamSet Remark : Strings are given under Hollerith form.

◆ ReceiveName()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::ReceiveName ( ) const

Returns the name of the receiving system.

◆ Resolution()

double IGESData_GlobalSection::Resolution ( ) const

Returns the resolution used in the IGES file.

◆ Scale()

double IGESData_GlobalSection::Scale ( ) const

Returns the scale used in the IGES file.

◆ SendName()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::SendName ( ) const

Returns the name of the sending system.

◆ Separator()

char IGESData_GlobalSection::Separator ( ) const

Returns the parameter delimiter character.

◆ SetApplicationProtocol()

void IGESData_GlobalSection::SetApplicationProtocol ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetAuthorName()

void IGESData_GlobalSection::SetAuthorName ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetCascadeUnit()

void IGESData_GlobalSection::SetCascadeUnit ( const double theUnit )

◆ SetCompanyName()

void IGESData_GlobalSection::SetCompanyName ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetDate()

void IGESData_GlobalSection::SetDate ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetDraftingStandard()

void IGESData_GlobalSection::SetDraftingStandard ( const int val )

◆ SetEndMark()

void IGESData_GlobalSection::SetEndMark ( const char val )

◆ SetFileName()

void IGESData_GlobalSection::SetFileName ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetIGESVersion()

void IGESData_GlobalSection::SetIGESVersion ( const int val )

◆ SetIntegerBits()

void IGESData_GlobalSection::SetIntegerBits ( const int val )

◆ SetInterfaceVersion()

void IGESData_GlobalSection::SetInterfaceVersion ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetLastChangeDate() [1/2]

void IGESData_GlobalSection::SetLastChangeDate ( )

◆ SetLastChangeDate() [2/2]

void IGESData_GlobalSection::SetLastChangeDate ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetLineWeightGrad()

void IGESData_GlobalSection::SetLineWeightGrad ( const int val )

◆ SetMaxCoord()

void IGESData_GlobalSection::SetMaxCoord ( const double val = 0.0 )

◆ SetMaxDigitsDouble()

void IGESData_GlobalSection::SetMaxDigitsDouble ( const int val )

◆ SetMaxDigitsSingle()

void IGESData_GlobalSection::SetMaxDigitsSingle ( const int val )

◆ SetMaxLineWeight()

void IGESData_GlobalSection::SetMaxLineWeight ( const double val )

◆ SetMaxPower10Double()

void IGESData_GlobalSection::SetMaxPower10Double ( const int val )

◆ SetMaxPower10Single()

void IGESData_GlobalSection::SetMaxPower10Single ( const int val )

◆ SetReceiveName()

void IGESData_GlobalSection::SetReceiveName ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetResolution()

void IGESData_GlobalSection::SetResolution ( const double val )

◆ SetScale()

void IGESData_GlobalSection::SetScale ( const double val )

◆ SetSendName()

void IGESData_GlobalSection::SetSendName ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetSeparator()

void IGESData_GlobalSection::SetSeparator ( const char val )

◆ SetSystemId()

void IGESData_GlobalSection::SetSystemId ( const occ::handle< TCollection_HAsciiString > & val )

◆ SetUnitFlag()

void IGESData_GlobalSection::SetUnitFlag ( const int val )

◆ SetUnitName()

void IGESData_GlobalSection::SetUnitName ( const occ::handle< TCollection_HAsciiString > & val )

◆ SystemId()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::SystemId ( ) const

Returns the Native System ID of the system that created the IGES file.

◆ TranslatedFromHollerith()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::TranslatedFromHollerith ( const occ::handle< TCollection_HAsciiString > & astr ) const

Returns a string withpout its Hollerith marks (nnnH ahead). Remark : all strings stored in GlobalSection are expurged from Hollerith information (without nnnH) If <astr> is not Hollerith form, it is simply copied.

◆ UnitFlag()

int IGESData_GlobalSection::UnitFlag ( ) const

Returns the unit flag that was used to write the IGES file.

◆ UnitName()

occ::handle< TCollection_HAsciiString > IGESData_GlobalSection::UnitName ( ) const

Returns the name of the unit the IGES file was written in.

◆ UnitValue()

double IGESData_GlobalSection::UnitValue ( ) const

Returns the unit value (in meters) that the IGES file was written in.

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

IGESData_GlobalSection.hxx

Public Member Functions

Static Public Member Functions