Rogue Wave Views
Prototypes Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Friends
IlvGroupInputFile Class Reference

Main class for reading groups from a stream. It provides contextual information. More...

#include <ilviews/protos/groupio.h>

Inheritance diagram for IlvGroupInputFile:
IlvGroupFile

Public Member Functions

istream & getStream ()
 Returns the input stream associated with the context. More...
 
IlSymbolreadValue (IlBoolean allowNull=IlFalse)
 Allows you to safely read any character string saved with IlvOutputFile::writeValue. More...
 
- Public Member Functions inherited from IlvGroupFile
IlFloat getVersion ()
 Returns the file version. More...
 
void setVersion (IlFloat v)
 Lets you set the version of an output file in order to write files compatible with previous versions of the prototypes library. More...
 

Friends

class IlvGroup
 
class IlvGroupNode
 
class IlvSubGroupNode
 

Detailed Description

Main class for reading groups from a stream. It provides contextual information.

Library: ilvproto

Group files should not be created directly by the application: they are generated internally by methods of other classes of the prototypes library. You will never need to use this class directly, unless you write new subclasses of IlvGroupNode.

See also
IlvGroupNode, IlvGroupOutputFile.

Member Function Documentation

§ getStream()

istream& IlvGroupInputFile::getStream ( )

Returns the input stream associated with the context.

Returns
The input stream associated with the context.

§ readValue()

IlSymbol* IlvGroupInputFile::readValue ( IlBoolean  allowNull = IlFalse)

Allows you to safely read any character string saved with IlvOutputFile::writeValue.

The accessor parameters should be read using this method.

Parameters
allowNullAllows the method to return 0 if no string was read. If set to IlFalse, the function will return the symbol with the name "".

© Copyright 2017, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.