IGESData_GlobalSection Class Reference

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, <br> Warning : No default value is provided More...
void	Init (const Handle< Interface_ParamSet > &params, 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 More...
void	CopyRefs ()
	Copies data referenced by Handle (that is, Strings) usefull to "isolate" a GlobalSection after copy by "=" (from a Model to another Model for instance) More...
Handle_Interface_ParamSet	Params () const
	Returns all contained data in the form of a ParamSet Remark : Strings are given under Hollerith form More...
Handle_TCollection_HAsciiString	TranslatedFromHollerith (const Handle< TCollection_HAsciiString > &astr) const
	Returns a string withpout its Hollerith marks (nnnH ahead). Remark : all strings stored in GlobalSection are expurged from Hollerith informations (without nnnH) If <astr> is not Hollerith form, it is simply copied More...
Standard_Character	Separator () const
	Returns the parameter delimiter character. More...
Standard_Character	EndMark () const
	Returns the record delimiter character. More...
Handle_TCollection_HAsciiString	SendName () const
	Returns the name of the sending system. More...
Handle_TCollection_HAsciiString	FileName () const
	Returns the name of the IGES file. More...
Handle_TCollection_HAsciiString	SystemId () const
	Returns the Native System ID of the system that created the IGES file. More...
Handle_TCollection_HAsciiString	InterfaceVersion () const
	Returns the name of the pre-processor used to write the IGES file. More...
Standard_Integer	IntegerBits () const
	Returns the number of binary bits for integer representations. More...
Standard_Integer	MaxPower10Single () const
	Returns the maximum power of a decimal representation of a single-precision floating point number in the sending system. More...
Standard_Integer	MaxDigitsSingle () const
Standard_Integer	MaxPower10Double () const
	Returns the maximum power of a decimal representation of a double-precision floating point number in the sending system. More...
Standard_Integer	MaxDigitsDouble () const
Handle_TCollection_HAsciiString	ReceiveName () const
	Returns the name of the receiving system. More...
Standard_Real	Scale () const
	Returns the scale used in the IGES file. More...
Standard_Integer	UnitFlag () const
	Returns the unit flag that was used to write the IGES file. More...
Handle_TCollection_HAsciiString	UnitName () const
	Returns the name of the unit the IGES file was written in. More...
Standard_Integer	LineWeightGrad () const
	Returns the maximum number of line weight gradations. More...
Standard_Real	MaxLineWeight () const
	Returns the of maximum line weight width in IGES file units. More...
Handle_TCollection_HAsciiString	Date () const
	Returns the IGES file creation date. More...
Standard_Real	Resolution () const
	Returns the resolution used in the IGES file. More...
Standard_Real	MaxCoord () const
	Returns the approximate maximum coordinate value found in the model. More...
Standard_Boolean	HasMaxCoord () const
	Returns True if the approximate maximum coordinate value found in the model is greater than 0. More...
Handle_TCollection_HAsciiString	AuthorName () const
	Returns the name of the IGES file author. More...
Handle_TCollection_HAsciiString	CompanyName () const
	Returns the name of the company where the IGES file was written. More...
Standard_Integer	IGESVersion () const
	Returns the IGES version that the IGES file was written in. More...
Standard_Integer	DraftingStandard () const
Handle_TCollection_HAsciiString	LastChangeDate () const
	Returns the date and time when the model was created or last modified (for IGES 5.1 and later). More...
Standard_Boolean	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. More...
void	SetLastChangeDate ()
Handle_TCollection_HAsciiString	ApplicationProtocol () const
Standard_Boolean	HasApplicationProtocol () const
Standard_Real	UnitValue () const
	Returns the unit value (in <br> meters) that the IGES file was written in. More...
void	SetSeparator (const Standard_Character val)
void	SetEndMark (const Standard_Character val)
void	SetSendName (const Handle< TCollection_HAsciiString > &val)
void	SetFileName (const Handle< TCollection_HAsciiString > &val)
void	SetSystemId (const Handle< TCollection_HAsciiString > &val)
void	SetInterfaceVersion (const Handle< TCollection_HAsciiString > &val)
void	SetIntegerBits (const Standard_Integer val)
void	SetMaxPower10Single (const Standard_Integer val)
void	SetMaxDigitsSingle (const Standard_Integer val)
void	SetMaxPower10Double (const Standard_Integer val)
void	SetMaxDigitsDouble (const Standard_Integer val)
void	SetReceiveName (const Handle< TCollection_HAsciiString > &val)
void	SetScale (const Standard_Real val)
void	SetUnitFlag (const Standard_Integer val)
void	SetUnitName (const Handle< TCollection_HAsciiString > &val)
void	SetLineWeightGrad (const Standard_Integer val)
void	SetMaxLineWeight (const Standard_Real val)
void	SetDate (const Handle< TCollection_HAsciiString > &val)
void	SetResolution (const Standard_Real val)
void	SetMaxCoord (const Standard_Real val=0.0)
void	MaxMaxCoord (const Standard_Real val=0.0)
void	MaxMaxCoords (const gp_XYZ &xyz)
void	SetAuthorName (const Handle< TCollection_HAsciiString > &val)
void	SetCompanyName (const Handle< TCollection_HAsciiString > &val)
void	SetIGESVersion (const Standard_Integer val)
void	SetDraftingStandard (const Standard_Integer val)
void	SetLastChangeDate (const Handle< TCollection_HAsciiString > &val)
void	SetApplicationProtocol (const Handle< TCollection_HAsciiString > &val)

Static Public Member Functions
static Handle_TCollection_HAsciiString	NewDateString (const Standard_Integer year, const Standard_Integer month, const Standard_Integer day, const Standard_Integer hour, const Standard_Integer minut, const Standard_Integer second, const Standard_Integer 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: More...
static Handle_TCollection_HAsciiString	NewDateString (const Handle< TCollection_HAsciiString > &date, const Standard_Integer 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. More...

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

(

)

Creates an empty GlobalSection, ready to be filled, <br>

Warning : No default value is provided

Member Function Documentation

Handle_TCollection_HAsciiString IGESData_GlobalSection::ApplicationProtocol

(

)

const

Handle_TCollection_HAsciiString IGESData_GlobalSection::AuthorName

(

)

const

Returns the name of the IGES file author.

Handle_TCollection_HAsciiString IGESData_GlobalSection::CompanyName

(

)

const

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

void IGESData_GlobalSection::CopyRefs

(

)

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

Handle_TCollection_HAsciiString IGESData_GlobalSection::Date

(

)

const

Returns the IGES file creation date.

Standard_Integer IGESData_GlobalSection::DraftingStandard

(

)

const

Standard_Character IGESData_GlobalSection::EndMark

(

)

const

Returns the record delimiter character.

Handle_TCollection_HAsciiString IGESData_GlobalSection::FileName

(

)

const

Returns the name of the IGES file.

Standard_Boolean IGESData_GlobalSection::HasApplicationProtocol

(

)

const

Standard_Boolean 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.

Standard_Boolean IGESData_GlobalSection::HasMaxCoord

(

)

const

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

Standard_Integer IGESData_GlobalSection::IGESVersion

(

)

const

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

void IGESData_GlobalSection::Init	(	const Handle< Interface_ParamSet > &	params,
		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

Standard_Integer IGESData_GlobalSection::IntegerBits

(

)

const

Returns the number of binary bits for integer representations.

Handle_TCollection_HAsciiString IGESData_GlobalSection::InterfaceVersion

(

)

const

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

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).

Standard_Integer IGESData_GlobalSection::LineWeightGrad

(

)

const

Returns the maximum number of line weight gradations.

Standard_Real IGESData_GlobalSection::MaxCoord

(

)

const

Returns the approximate maximum coordinate value found in the model.

Standard_Integer IGESData_GlobalSection::MaxDigitsDouble

(

)

const

Standard_Integer IGESData_GlobalSection::MaxDigitsSingle

(

)

const

Standard_Real IGESData_GlobalSection::MaxLineWeight

(

)

const

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

void IGESData_GlobalSection::MaxMaxCoord

(

const Standard_Real

val = 0.0

)

void IGESData_GlobalSection::MaxMaxCoords

(

const gp_XYZ &

xyz

)

Standard_Integer IGESData_GlobalSection::MaxPower10Double

(

)

const

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

Standard_Integer IGESData_GlobalSection::MaxPower10Single

(

)

const

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

static Handle_TCollection_HAsciiString IGESData_GlobalSection::NewDateString ( const Standard_Integer  year, const Standard_Integer  month, const Standard_Integer  day, const Standard_Integer  hour, const Standard_Integer  minut, const Standard_Integer  second, const Standard_Integer  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, <br>
      -       0: YYYYMMDD.HHNNSS, <br>
     -       1: YYYY-MM-DD:HH-NN-SS, where: <br>

• 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).
  

static Handle_TCollection_HAsciiString IGESData_GlobalSection::NewDateString ( const Handle< TCollection_HAsciiString > &  date, const Standard_Integer  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.

Handle_Interface_ParamSet IGESData_GlobalSection::Params

(

)

const

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

Handle_TCollection_HAsciiString IGESData_GlobalSection::ReceiveName

(

)

const

Returns the name of the receiving system.

Standard_Real IGESData_GlobalSection::Resolution

(

)

const

Returns the resolution used in the IGES file.

Standard_Real IGESData_GlobalSection::Scale

(

)

const

Returns the scale used in the IGES file.

Handle_TCollection_HAsciiString IGESData_GlobalSection::SendName

(

)

const

Returns the name of the sending system.

Standard_Character IGESData_GlobalSection::Separator

(

)

const

Returns the parameter delimiter character.

void IGESData_GlobalSection::SetApplicationProtocol

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetAuthorName

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetCompanyName

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetDate

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetDraftingStandard

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetEndMark

(

const Standard_Character

val

)

void IGESData_GlobalSection::SetFileName

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetIGESVersion

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetIntegerBits

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetInterfaceVersion

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetLastChangeDate

(

)

void IGESData_GlobalSection::SetLastChangeDate

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetLineWeightGrad

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetMaxCoord

(

const Standard_Real

val = 0.0

)

void IGESData_GlobalSection::SetMaxDigitsDouble

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetMaxDigitsSingle

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetMaxLineWeight

(

const Standard_Real

val

)

void IGESData_GlobalSection::SetMaxPower10Double

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetMaxPower10Single

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetReceiveName

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetResolution

(

const Standard_Real

val

)

void IGESData_GlobalSection::SetScale

(

const Standard_Real

val

)

void IGESData_GlobalSection::SetSendName

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetSeparator

(

const Standard_Character

val

)

void IGESData_GlobalSection::SetSystemId

(

const Handle< TCollection_HAsciiString > &

val

)

void IGESData_GlobalSection::SetUnitFlag

(

const Standard_Integer

val

)

void IGESData_GlobalSection::SetUnitName

(

const Handle< TCollection_HAsciiString > &

val

)

Handle_TCollection_HAsciiString IGESData_GlobalSection::SystemId

(

)

const

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

Handle_TCollection_HAsciiString IGESData_GlobalSection::TranslatedFromHollerith

(

const Handle< TCollection_HAsciiString > &

astr

)

const

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

Standard_Integer IGESData_GlobalSection::UnitFlag

(

)

const

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

Handle_TCollection_HAsciiString IGESData_GlobalSection::UnitName

(

)

const

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

Standard_Real IGESData_GlobalSection::UnitValue

(

)

const

 Returns the unit value (in <br>

meters) that the IGES file was written in.

---

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

• IGESData_GlobalSection.hxx