Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

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, 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) useful to "isolate" a GlobalSection after copy by "=" (from a Model to another Model for instance) More...
 
Handle< Interface_ParamSetParams () const
 Returns all contained data in the form of a ParamSet Remark : Strings are given under Hollerith form. More...
 
Handle< TCollection_HAsciiStringTranslatedFromHollerith (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 information (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_HAsciiStringSendName () const
 Returns the name of the sending system. More...
 
Handle< TCollection_HAsciiStringFileName () const
 Returns the name of the IGES file. More...
 
Handle< TCollection_HAsciiStringSystemId () const
 Returns the Native System ID of the system that created the IGES file. More...
 
Handle< TCollection_HAsciiStringInterfaceVersion () 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_HAsciiStringReceiveName () const
 Returns the name of the receiving system. More...
 
Standard_Real Scale () const
 Returns the scale used in the IGES file. More...
 
Standard_Real CascadeUnit () const
 Returns the system length unit. More...
 
Standard_Integer UnitFlag () const
 Returns the unit flag that was used to write the IGES file. More...
 
Handle< TCollection_HAsciiStringUnitName () 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_HAsciiStringDate () 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_HAsciiStringAuthorName () const
 Returns the name of the IGES file author. More...
 
Handle< TCollection_HAsciiStringCompanyName () 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_HAsciiStringLastChangeDate () 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_HAsciiStringApplicationProtocol () const
 
Standard_Boolean HasApplicationProtocol () const
 
Standard_Real UnitValue () const
 Returns the unit value (in 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 SetCascadeUnit (const Standard_Real theUnit)
 
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_HAsciiStringNewDateString (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_HAsciiStringNewDateString (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::IGESData_GlobalSection ( )

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

Member Function Documentation

◆ ApplicationProtocol()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::ApplicationProtocol ( ) const

◆ AuthorName()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::AuthorName ( ) const

Returns the name of the IGES file author.

◆ CascadeUnit()

Standard_Real IGESData_GlobalSection::CascadeUnit ( ) const

Returns the system length unit.

◆ CompanyName()

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

Handle< TCollection_HAsciiString > IGESData_GlobalSection::Date ( ) const

Returns the IGES file creation date.

◆ DraftingStandard()

Standard_Integer IGESData_GlobalSection::DraftingStandard ( ) const

◆ EndMark()

Standard_Character IGESData_GlobalSection::EndMark ( ) const

Returns the record delimiter character.

◆ FileName()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::FileName ( ) const

Returns the name of the IGES file.

◆ HasApplicationProtocol()

Standard_Boolean IGESData_GlobalSection::HasApplicationProtocol ( ) const

◆ HasLastChangeDate()

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.

◆ HasMaxCoord()

Standard_Boolean IGESData_GlobalSection::HasMaxCoord ( ) const

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

◆ IGESVersion()

Standard_Integer IGESData_GlobalSection::IGESVersion ( ) const

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

◆ Init()

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.

◆ IntegerBits()

Standard_Integer IGESData_GlobalSection::IntegerBits ( ) const

Returns the number of binary bits for integer representations.

◆ InterfaceVersion()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::InterfaceVersion ( ) const

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

◆ LastChangeDate()

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

Standard_Integer IGESData_GlobalSection::LineWeightGrad ( ) const

Returns the maximum number of line weight gradations.

◆ MaxCoord()

Standard_Real IGESData_GlobalSection::MaxCoord ( ) const

Returns the approximate maximum coordinate value found in the model.

◆ MaxDigitsDouble()

Standard_Integer IGESData_GlobalSection::MaxDigitsDouble ( ) const

◆ MaxDigitsSingle()

Standard_Integer IGESData_GlobalSection::MaxDigitsSingle ( ) const

◆ MaxLineWeight()

Standard_Real IGESData_GlobalSection::MaxLineWeight ( ) const

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

◆ MaxMaxCoord()

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

◆ MaxMaxCoords()

void IGESData_GlobalSection::MaxMaxCoords ( const gp_XYZ xyz)

◆ MaxPower10Double()

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.

◆ MaxPower10Single()

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.

◆ NewDateString() [1/2]

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.

◆ NewDateString() [2/2]

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

◆ Params()

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

Handle< TCollection_HAsciiString > IGESData_GlobalSection::ReceiveName ( ) const

Returns the name of the receiving system.

◆ Resolution()

Standard_Real IGESData_GlobalSection::Resolution ( ) const

Returns the resolution used in the IGES file.

◆ Scale()

Standard_Real IGESData_GlobalSection::Scale ( ) const

Returns the scale used in the IGES file.

◆ SendName()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::SendName ( ) const

Returns the name of the sending system.

◆ Separator()

Standard_Character IGESData_GlobalSection::Separator ( ) const

Returns the parameter delimiter character.

◆ SetApplicationProtocol()

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

◆ SetAuthorName()

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

◆ SetCascadeUnit()

void IGESData_GlobalSection::SetCascadeUnit ( const Standard_Real  theUnit)

◆ SetCompanyName()

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

◆ SetDate()

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

◆ SetDraftingStandard()

void IGESData_GlobalSection::SetDraftingStandard ( const Standard_Integer  val)

◆ SetEndMark()

void IGESData_GlobalSection::SetEndMark ( const Standard_Character  val)

◆ SetFileName()

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

◆ SetIGESVersion()

void IGESData_GlobalSection::SetIGESVersion ( const Standard_Integer  val)

◆ SetIntegerBits()

void IGESData_GlobalSection::SetIntegerBits ( const Standard_Integer  val)

◆ SetInterfaceVersion()

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

◆ SetLastChangeDate() [1/2]

void IGESData_GlobalSection::SetLastChangeDate ( )

◆ SetLastChangeDate() [2/2]

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

◆ SetLineWeightGrad()

void IGESData_GlobalSection::SetLineWeightGrad ( const Standard_Integer  val)

◆ SetMaxCoord()

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

◆ SetMaxDigitsDouble()

void IGESData_GlobalSection::SetMaxDigitsDouble ( const Standard_Integer  val)

◆ SetMaxDigitsSingle()

void IGESData_GlobalSection::SetMaxDigitsSingle ( const Standard_Integer  val)

◆ SetMaxLineWeight()

void IGESData_GlobalSection::SetMaxLineWeight ( const Standard_Real  val)

◆ SetMaxPower10Double()

void IGESData_GlobalSection::SetMaxPower10Double ( const Standard_Integer  val)

◆ SetMaxPower10Single()

void IGESData_GlobalSection::SetMaxPower10Single ( const Standard_Integer  val)

◆ SetReceiveName()

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

◆ SetResolution()

void IGESData_GlobalSection::SetResolution ( const Standard_Real  val)

◆ SetScale()

void IGESData_GlobalSection::SetScale ( const Standard_Real  val)

◆ SetSendName()

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

◆ SetSeparator()

void IGESData_GlobalSection::SetSeparator ( const Standard_Character  val)

◆ SetSystemId()

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

◆ SetUnitFlag()

void IGESData_GlobalSection::SetUnitFlag ( const Standard_Integer  val)

◆ SetUnitName()

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

◆ SystemId()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::SystemId ( ) const

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

◆ TranslatedFromHollerith()

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 information (without nnnH) If <astr> is not Hollerith form, it is simply copied.

◆ UnitFlag()

Standard_Integer IGESData_GlobalSection::UnitFlag ( ) const

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

◆ UnitName()

Handle< TCollection_HAsciiString > IGESData_GlobalSection::UnitName ( ) const

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

◆ UnitValue()

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