OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKIGES
IGESData


IGESData_IGESModel Class Reference

Defines the file header and
entities for IGES files. These headers and entities result from
a complete data translation using the IGES data exchange processor.
Each entity is contained in a single model only and has a
unique identifier. You can access this identifier using the method Number.
Gives an access to the general data in the Start and the Global
sections of an IGES file.
The IGES file includes the following sections:
-Start,
-Global,
-Directory Entry,
-Parameter Data,
-Terminate
.

#include <IGESData_IGESModel.hxx>

Inheritance diagram for IGESData_IGESModel:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT IGESData_IGESModel ()
Standard_EXPORT void ClearHeader ()
 Erases all data specific to IGES file Header (Start + Global)
.
Standard_EXPORT void DumpHeader (const Handle(Message_Messenger)&S, const Standard_Integer level=0) const
 Prints the IGES file header
(Start and Global Sections) to the log file. The integer
parameter is intended to be used as a level indicator but is not used at present.
.
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString StartSection () const
 Returns Model's Start Section (list of comment lines)
.
Standard_EXPORT Standard_Integer NbStartLines () const
 Returns the count of recorded Start Lines
.
Standard_EXPORT Standard_CString StartLine (const Standard_Integer num) const
 Returns a line from the IGES file
Start section by specifying its number. An empty string is
returned if the number given is out of range, the range being
from 1 to NbStartLines.
.
Standard_EXPORT void ClearStartSection ()
 Clears the IGES file Start Section
.
Standard_EXPORT void SetStartSection (const Handle(TColStd_HSequenceOfHAsciiString)&list, const Standard_Boolean copy=Standard_True)
 Sets a new Start section from a list of strings.
If copy is false, the Start section will be shared. Any
modifications made to the strings later on, will have an effect on
the Start section. If copy is true (default value),
an independent copy of the strings is created and used as
the Start section. Any modifications made to the strings
later on, will have no effect on the Start section.
.
Standard_EXPORT void AddStartLine (const Standard_CString line, const Standard_Integer atnum=0)
 Adds a new string to the existing
Start section at the end if atnum is 0 or not given, or before
atnumth line.
.
Standard_EXPORT const IGESData_GlobalSectionGlobalSection () const
 Returns the Global section of the IGES file.
.
Standard_EXPORT void SetGlobalSection (const IGESData_GlobalSection &header)
 Sets the Global section of the IGES file.
.
Standard_EXPORT Standard_Boolean ApplyStatic (const Standard_CString param="")
 Sets some of the Global section
parameters with the values defined by the translation
parameters. param may be:
- receiver (value read in XSTEP.iges.header.receiver),
- author (value read in XSTEP.iges.header.author),
- company (value read in XSTEP.iges.header.company).
The default value for param is an empty string.
Returns True when done and if param is given, False if param is
unknown or empty. Note: Set the unit in the IGES
file Global section via IGESData_BasicEditor class.
.
Standard_EXPORT Handle_IGESData_IGESEntity Entity (const Standard_Integer num) const
 Returns an IGES entity given by its rank number.
.
Standard_EXPORT Standard_Integer DNum (const Handle(IGESData_IGESEntity)&ent) const
 Returns the equivalent DE Number for an Entity, i.e.
2*Number(ent)-1 , or 0 if <ent> is unknown from <me>
This DE Number is used for File Writing for instance
.
Standard_EXPORT void GetFromAnother (const Handle(Interface_InterfaceModel)&other)
 gets Header (GlobalSection) from another Model

Standard_EXPORT Handle_Interface_InterfaceModel NewEmptyModel () const
 Returns a New Empty Model, same type as <me> i.e. IGESModel
.
virtual Standard_EXPORT void VerifyCheck (Handle(Interface_Check)&ach) const
 Checks that the IGES file Global
section contains valid data that conforms to the IGES specifications.
.
Standard_EXPORT void SetLineWeights (const Standard_Real defw)
 Sets LineWeights of contained Entities according header data
(MaxLineWeight and LineWeightGrad) or to a default value for
undefined weights
.
Standard_EXPORT void ClearLabels ()
 erases specific labels, i.e. does nothing

Standard_EXPORT void PrintLabel (const Handle(Standard_Transient)&ent, const Handle(Message_Messenger)&S) const
 Prints label specific to IGES norm for a given entity, i.e.
its directory entry number (2*Number-1)
.
virtual Standard_EXPORT void PrintToLog (const Handle(Standard_Transient)&ent, const Handle(Message_Messenger)&S) const
 Prints label specific to IGES norm for a given -- --
entity, i.e. its directory entry number (2*Number-1)
in the log file format.
.
Standard_EXPORT void PrintInfo (const Handle(Standard_Transient)&ent, const Handle(Message_Messenger)&S) const
 Prints label specific to IGES norm for a given entity, i.e.
its directory entry number (2*Number-1)
.
Standard_EXPORT Handle_TCollection_HAsciiString StringLabel (const Handle(Standard_Transient)&ent) const
 Returns a string with the label attached to a given entity,
i.e. a string "Dnn" with nn = directory entry number (2*N-1)
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Handle_TColStd_HSequenceOfHAsciiString thestart
IGESData_GlobalSection theheader

Constructor & Destructor Documentation

Standard_EXPORT IGESData_IGESModel::IGESData_IGESModel  ) 
 


Member Function Documentation

Standard_EXPORT void IGESData_IGESModel::AddStartLine const Standard_CString  line,
const Standard_Integer  atnum = 0
 

Standard_EXPORT Standard_Boolean IGESData_IGESModel::ApplyStatic const Standard_CString  param = ""  ) 
 

Standard_EXPORT void IGESData_IGESModel::ClearHeader  )  [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT void IGESData_IGESModel::ClearLabels  )  [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT void IGESData_IGESModel::ClearStartSection  ) 
 

Standard_EXPORT Standard_Integer IGESData_IGESModel::DNum const Handle(IGESData_IGESEntity)&  ent  )  const
 

Standard_EXPORT void IGESData_IGESModel::DumpHeader const Handle(Message_Messenger)&  S,
const Standard_Integer  level = 0
const [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT Handle_IGESData_IGESEntity IGESData_IGESModel::Entity const Standard_Integer  num  )  const
 

Standard_EXPORT void IGESData_IGESModel::GetFromAnother const Handle(Interface_InterfaceModel)&  other  )  [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT const IGESData_GlobalSection& IGESData_IGESModel::GlobalSection  )  const
 

Standard_EXPORT const IGESData_IGESModel::Handle Standard_Type   )  const
 

Reimplemented from Interface_InterfaceModel.

Standard_EXPORT Standard_Integer IGESData_IGESModel::NbStartLines  )  const
 

Standard_EXPORT Handle_Interface_InterfaceModel IGESData_IGESModel::NewEmptyModel  )  const [virtual]
 

Implements Interface_InterfaceModel.

Standard_EXPORT void IGESData_IGESModel::PrintInfo const Handle(Standard_Transient)&  ent,
const Handle(Message_Messenger)&  S
const
 

Standard_EXPORT void IGESData_IGESModel::PrintLabel const Handle(Standard_Transient)&  ent,
const Handle(Message_Messenger)&  S
const [virtual]
 

Implements Interface_InterfaceModel.

virtual Standard_EXPORT void IGESData_IGESModel::PrintToLog const Handle(Standard_Transient)&  ent,
const Handle(Message_Messenger)&  S
const [virtual]
 

Reimplemented from Interface_InterfaceModel.

Standard_EXPORT void IGESData_IGESModel::SetGlobalSection const IGESData_GlobalSection header  ) 
 

Standard_EXPORT void IGESData_IGESModel::SetLineWeights const Standard_Real  defw  ) 
 

Standard_EXPORT void IGESData_IGESModel::SetStartSection const Handle(TColStd_HSequenceOfHAsciiString)&  list,
const Standard_Boolean  copy = Standard_True
 

Standard_EXPORT Standard_CString IGESData_IGESModel::StartLine const Standard_Integer  num  )  const
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString IGESData_IGESModel::StartSection  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString IGESData_IGESModel::StringLabel const Handle(Standard_Transient)&  ent  )  const [virtual]
 

Implements Interface_InterfaceModel.

virtual Standard_EXPORT void IGESData_IGESModel::VerifyCheck Handle(Interface_Check)&  ach  )  const [virtual]
 

Reimplemented from Interface_InterfaceModel.


Field Documentation

IGESData_GlobalSection IGESData_IGESModel::theheader [private]
 

Handle_TColStd_HSequenceOfHAsciiString IGESData_IGESModel::thestart [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:40:24 2008 for OpenCASCADE by  doxygen 1.4.1