LgfContents

Declared in lemon/lgf_reader.h, in the group LEMON Graph Format; the same class on the Doxygen site.

class LgfContents

Reader for the contents of the LGF file.

This class can be used to read the sections, the map names and the attributes from a file. Usually, the LEMON programs know that, which type of graph, which maps and which attributes should be read from a file, but in general tools (like glemon) the contents of an LGF file should be guessed somehow. This class reads the graph and stores the appropriate information for reading the graph.

LgfContents contents( "graph.lgf" );
contents.run();

// Does it contain any node section and arc section?
if( contents.nodeSectionNum() == 0 || contents.arcSectionNum() == 0 ) {
 std::cerr << "Failure, cannot find graph." << std::endl;
 return( -1 );
 }
std::cout << "The name of the default node section: "
          << contents.nodeSection( 0 ) << std::endl;
std::cout << "The number of the arc maps: "
          << contents.arcMapNames( 0 ).size() << std::endl;
std::cout << "The name of second arc map: "
          << contents.arcMapNames( 0 )[ 1 ] << std::endl;

Node Sections

inline int nodeSectionNum() const

Gives back the number of node sections in the file.

inline const std::string & nodeSection( int i ) const

Returns the node section name at the given position.

inline const std::vector< std::string > & nodeMapNames( int i ) const

Gives back the node maps for the given section.

Arc/Edge Sections

inline int arcSectionNum() const

Gives back the number of arc/edge sections in the file.

Note

It is synonym of edgeSectionNum().

inline const std::string & arcSection( int i ) const

Returns the arc/edge section name at the given position.

Note

It is synonym of edgeSection().

inline const std::vector< std::string > & arcMapNames( int i ) const

Gives back the arc/edge maps for the given section.

Note

It is synonym of edgeMapNames().

Synonyms

inline int edgeSectionNum() const

Gives back the number of arc/edge sections in the file.

Note

It is synonym of arcSectionNum().

inline const std::string & edgeSection( int i ) const

Returns the section name at the given position.

Note

It is synonym of arcSection().

inline const std::vector< std::string > & edgeMapNames( int i ) const

Gives back the edge maps for the given section.

Note

It is synonym of arcMapNames().

Attribute Sections

inline int attributeSectionNum() const

Gives back the number of attribute sections in the file.

inline const std::string & attributeSectionNames( int i ) const

Returns the attribute section name at the given position.

inline const std::vector< std::string > & attributes( int i ) const

Gives back the attributes for the given section.

Extra Sections

inline int extraSectionNum() const

Gives back the number of extra sections in the file.

inline const std::string & extraSection( int i ) const

Returns the extra section type at the given position.

Returns the section type at the given position.

Execution of the Contents Reader

inline void run()

Starts the reading.

This function starts the reading.

Public Functions

inline LgfContents( std::istream & is )

Constructor.

Construct an LGF contents reader, which reads from the given input stream.

inline LgfContents( const std::string & fn )

Constructor.

Construct an LGF contents reader, which reads from the given file.

inline LgfContents( const char * fn )

Constructor.

Construct an LGF contents reader, which reads from the given file.

inline ~LgfContents()

Destructor.