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

DataExchange
TKIGES
IGESData


IGESData_IGESWriter Class Reference

manages atomic file writing, under control of IGESModel :
prepare text to be sent then sends it
takes into account distinction between successive Sections

#include <IGESData_IGESWriter.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT IGESData_IGESWriter (const Handle(IGESData_IGESModel)&amodel)
 Creates an IGESWriter, empty ready to work
(see the methods SendModel and Print)
.
Standard_EXPORT IGESData_IGESWriter ()
 Default constructor (not used) to satisfy the compiler
.
Standard_EXPORT IGESData_IGESWriter (const IGESData_IGESWriter &other)
 Constructor by copy (not used) to satisfy the compiler
.
Standard_EXPORT Interface_FloatWriterFloatWriter ()
 Returns the embedded FloatWriter, which controls sending Reals
Use this method to access FloatWriter in order to consult or
change its options (MainFormat, FormatForRange,ZeroSuppress),
because it is returned as the address of its field
.
Standard_EXPORT Standard_Integer & WriteMode ()
 Returns the write mode, in order to be read and/or changed
Write Mode controls the way final print works
0 (D) : Normal IGES, 10 : FNES
.
Standard_EXPORT void SendStartLine (const Standard_CString startline)
 Sends an additionnal Starting Line : this is the way used to
send comments in an IGES File (at beginning of the file).
If the line is more than 72 char.s long, it is splited into
as many lines as required to send it completely
.
Standard_EXPORT void SendModel (const Handle(IGESData_Protocol)&protocol)
 Sends the complete IGESModel (Global Section, Entities as
Directory Entries & Parameter Lists, etc...)
i.e. fills a list of texts. Once filled, it can be sent by
method Print
.
Standard_EXPORT void SectionS ()
 declares sending of S section (only a declaration)
error if state is not initial

Standard_EXPORT void SectionG (const IGESData_GlobalSection &header)
 prepares sending of header, from a GlobalSection (stores it)
error if SectionS was not called just before
takes in account special characters (Separator, EndMark)

Standard_EXPORT void SectionsDP ()
 prepares sending of list of entities, as Sections D (directory
list) and P (Parameters lists, one per entity)
Entities will be then processed, one after the other
error if SectionG has not be called just before

Standard_EXPORT void SectionT ()
 declares sending of T section (only a declaration)
error if does not follow Entities sending

Standard_EXPORT void DirPart (const Handle(IGESData_IGESEntity)&anent)
 translates directory part of an Entity into a litteral DirPart
Some infos are computed after sending parameters
Error if not in sections DP or Stage not "Dir"

Standard_EXPORT void OwnParams (const Handle(IGESData_IGESEntity)&anent)
 sends own parameters of the entity, by sending firstly its
type, then calling specific method WriteOwnParams
Error if not in sections DP or Stage not "Own"

Standard_EXPORT void Associativities (const Handle(IGESData_IGESEntity)&anent)
 sends associativity list, as complement of parameters list
error if not in sections DP or Stage not "Associativity"

Standard_EXPORT void Properties (const Handle(IGESData_IGESEntity)&anent)
 sends property list, as complement of parameters list
error if not in sections DP or Stage not "Property"

Standard_EXPORT void EndEntity ()
 declares end of sending an entity (ends param list by ';')

Standard_EXPORT void SendVoid ()
 sends a void parameter, that is null text

Standard_EXPORT void Send (const Standard_Integer val)
 sends an Integer parameter

Standard_EXPORT void SendBoolean (const Standard_Boolean val)
 sends a Boolean parameter as an Integer value 0(False)/1(True)

Standard_EXPORT void Send (const Standard_Real val)
 sends a Real parameter. Works with FloatWriter

Standard_EXPORT void Send (const Handle(TCollection_HAsciiString)&val)
 sends a Text parameter under Hollerith form

Standard_EXPORT void Send (const Handle(IGESData_IGESEntity)&val, const Standard_Boolean negative=Standard_False)
 sends a Reference to an Entity (if its Number is N, its
pointer is 2*N-1)
If <val> is Null, "0" will be sent
If <negative> is True, "Pointer" is sent as negative

Standard_EXPORT void SendString (const Handle(TCollection_HAsciiString)&val)
 sends a parameter under its exact form given as a string

Standard_EXPORT void Send (const gp_XY &val)
 Sends a XY, interpreted as a couple of 2 Reals (X & Y)
.
Standard_EXPORT void Send (const gp_XYZ &val)
 Sends a XYZ, interpreted as a couple of 2 Reals (X , Y & Z)
.
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString SectionStrings (const Standard_Integer numsec) const
 Returns the list of strings for a section given its rank
1 : Start (if not empty) 2 : Global 3 or 4 : Parameters
RQ: no string list for Directory section
An empty section gives a null handle
.
Standard_EXPORT Standard_Boolean Print (Standard_OStream &S) const
 Writes result on an output defined as an OStream
resolves stored infos at this time; in particular, numbers of
lines used to adress P-section from D-section and final totals
Takes WriteMode into account
.

Private Member Functions

Standard_EXPORT void AddString (const Handle(TCollection_HAsciiString)&val, const Standard_Integer more=0)
 Basic action of adding a string to current parameter list as a
line; manages size limit (64 or 72 according Sestion G or P)
<more>, if precised, requires that <more> characters will
remain free on the current line once this AddString done
.
Standard_EXPORT void AddString (const Standard_CString val, const Standard_Integer lnval=0, const Standard_Integer more=0)
 Basic action of adding a string to current parameter list as a
line. Manages size limit (64 or 72 according Sestion G or P)
<val> is the string and <lnval> its length. If <lnval> is not
given, it is computed by strlen(val).
<more>, if precised, requires that <more> characters will
remain free on the current line once this AddString done
.
Standard_EXPORT void AddChar (const Standard_Character val, const Standard_Integer more=0)
 Adds a string defined as a single character (for instance, the
parameter separator). Manages size limit
<more>, if precised, requires that <more> characters will
remain free on the current line once this AddString done
.

Private Attributes

Handle_IGESData_IGESModel themodel
Handle_TColStd_HSequenceOfHAsciiString thestar
Handle_TColStd_HSequenceOfHAsciiString thehead
Standard_Character thesep
Standard_Character theendm
IGESData_Array1OfDirPart thedirs
TColStd_Array1OfInteger thepnum
Handle_TColStd_HSequenceOfHAsciiString thepars
Standard_Integer thesect
IGESData_ReadStage thestep
Interface_LineBuffer thecurr
Standard_Integer themodew
Interface_FloatWriter thefloatw


Constructor & Destructor Documentation

Standard_EXPORT IGESData_IGESWriter::IGESData_IGESWriter const Handle(IGESData_IGESModel)&  amodel  ) 
 

Standard_EXPORT IGESData_IGESWriter::IGESData_IGESWriter  ) 
 

Standard_EXPORT IGESData_IGESWriter::IGESData_IGESWriter const IGESData_IGESWriter other  ) 
 


Member Function Documentation

Standard_EXPORT void IGESData_IGESWriter::AddChar const Standard_Character  val,
const Standard_Integer  more = 0
[private]
 

Standard_EXPORT void IGESData_IGESWriter::AddString const Standard_CString  val,
const Standard_Integer  lnval = 0,
const Standard_Integer  more = 0
[private]
 

Standard_EXPORT void IGESData_IGESWriter::AddString const Handle(TCollection_HAsciiString)&  val,
const Standard_Integer  more = 0
[private]
 

Standard_EXPORT void IGESData_IGESWriter::Associativities const Handle(IGESData_IGESEntity)&  anent  ) 
 

Standard_EXPORT void IGESData_IGESWriter::DirPart const Handle(IGESData_IGESEntity)&  anent  ) 
 

Standard_EXPORT void IGESData_IGESWriter::EndEntity  ) 
 

Standard_EXPORT Interface_FloatWriter& IGESData_IGESWriter::FloatWriter  ) 
 

void IGESData_IGESWriter::operator delete void *  anAddress  )  [inline]
 

void* IGESData_IGESWriter::operator new size_t  size  )  [inline]
 

void* IGESData_IGESWriter::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT void IGESData_IGESWriter::OwnParams const Handle(IGESData_IGESEntity)&  anent  ) 
 

Standard_EXPORT Standard_Boolean IGESData_IGESWriter::Print Standard_OStream &  S  )  const
 

Standard_EXPORT void IGESData_IGESWriter::Properties const Handle(IGESData_IGESEntity)&  anent  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SectionG const IGESData_GlobalSection header  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SectionS  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SectionsDP  ) 
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString IGESData_IGESWriter::SectionStrings const Standard_Integer  numsec  )  const
 

Standard_EXPORT void IGESData_IGESWriter::SectionT  ) 
 

Standard_EXPORT void IGESData_IGESWriter::Send const gp_XYZ &  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::Send const gp_XY &  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::Send const Handle(IGESData_IGESEntity)&  val,
const Standard_Boolean  negative = Standard_False
 

Standard_EXPORT void IGESData_IGESWriter::Send const Handle(TCollection_HAsciiString)&  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::Send const Standard_Real  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::Send const Standard_Integer  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SendBoolean const Standard_Boolean  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SendModel const Handle(IGESData_Protocol)&  protocol  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SendStartLine const Standard_CString  startline  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SendString const Handle(TCollection_HAsciiString)&  val  ) 
 

Standard_EXPORT void IGESData_IGESWriter::SendVoid  ) 
 

Standard_EXPORT Standard_Integer& IGESData_IGESWriter::WriteMode  ) 
 


Field Documentation

Interface_LineBuffer IGESData_IGESWriter::thecurr [private]
 

IGESData_Array1OfDirPart IGESData_IGESWriter::thedirs [private]
 

Standard_Character IGESData_IGESWriter::theendm [private]
 

Interface_FloatWriter IGESData_IGESWriter::thefloatw [private]
 

Handle_TColStd_HSequenceOfHAsciiString IGESData_IGESWriter::thehead [private]
 

Handle_IGESData_IGESModel IGESData_IGESWriter::themodel [private]
 

Standard_Integer IGESData_IGESWriter::themodew [private]
 

Handle_TColStd_HSequenceOfHAsciiString IGESData_IGESWriter::thepars [private]
 

TColStd_Array1OfInteger IGESData_IGESWriter::thepnum [private]
 

Standard_Integer IGESData_IGESWriter::thesect [private]
 

Standard_Character IGESData_IGESWriter::thesep [private]
 

Handle_TColStd_HSequenceOfHAsciiString IGESData_IGESWriter::thestar [private]
 

IGESData_ReadStage IGESData_IGESWriter::thestep [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