Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
Interface_LineBuffer Class Reference

Simple Management of a Line Buffer, to be used by Interface
File Writers.
While a String is suitable to do that, this class ensures an
optimised Memory Management, because this is a hard point of
File Writing.

#include <Interface_LineBuffer.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC Interface_LineBuffer (const Standard_Integer size=10)
 Creates a LineBuffer with an absolute maximum size
(Default value is only to satisfy compiler requirement)

void SetMax (const Standard_Integer max)
 Changes Maximum allowed size of Buffer.
If <max> is Zero, Maximum size is set to the initial size.

void SetInitial (const Standard_Integer initial)
 Sets an Initial reservation for Blank characters
(this reservation is counted in the size of the current Line)

void SetKeep ()
 Sets a Keep Status at current Length. It means that at next
Move, the new line will begin by characters between Keep + 1
and current Length

Standard_Boolean CanGet (const Standard_Integer more)
 Returns True if there is room enough to add <more> characters
Else, it is required to Dump the Buffer before refilling it
<more> is recorded to manage SetKeep status

Standard_CString Content () const
 Returns the Content of the LineBuffer
was C++ : return const

Standard_Integer Length () const
 Returns the Length of the LineBuffer

void Clear ()
 Clears completely the LineBuffer

void FreezeInitial ()
 Inhibits effect of SetInitial until the next Move (i.e. Keep)
Then Prepare will not insert initial blanks, but further ones
will. This allows to cancel initial blanks on an internal Split
A call to SetInitial has no effect on this until Move

void Move (TCollection_AsciiString &str)
 Fills a AsciiString <str> with the Content of the Line Buffer,
then Clears the LineBuffer

void Move (const Handle< TCollection_HAsciiString > &str)
 Same as above, but <str> is known through a Handle

Handle_TCollection_HAsciiString Moved ()
 Same as above, but generates the HAsciiString

void Add (const Standard_CString text)
 Adds a text as a CString. Its Length is evaluated from the
text (by C function strlen)

void Add (const Standard_CString text, const Standard_Integer lntext)
 Adds a text as a CString. Its length is given as <lntext>

void Add (const TCollection_AsciiString &text)
 Adds a text as a AsciiString from TCollection

void Add (const Standard_Character text)
 Adds a text made of only ONE Character


Constructor & Destructor Documentation


Member Function Documentation

Handle_TCollection_HAsciiString Interface_LineBuffer::Moved ( )

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