WPSEntry Class Reference

basic class to store an entry in a file This contained : More...

#include <WPSEntry.h>

Inheritance diagram for WPSEntry:
WPS4TextInternal::Note

Public Member Functions

 WPSEntry ()
 constructor More...
 
virtual ~WPSEntry ()
 destructor More...
 
void setBegin (long off)
 sets the begin offset More...
 
void setLength (long l)
 sets the zone size More...
 
void setEnd (long e)
 sets the end offset More...
 
long begin () const
 returns the begin offset More...
 
long end () const
 returns the end offset More...
 
long length () const
 returns the length of the zone More...
 
bool valid (bool checkId=false) const
 returns true if the zone length is positive More...
 
bool operator== (const WPSEntry &a) const
 basic operator== More...
 
bool operator!= (const WPSEntry &a) const
 basic operator!= More...
 
bool isParsed () const
 a flag to know if the entry was parsed or not More...
 
void setParsed (bool ok=true) const
 sets the flag m_parsed to true or false More...
 
void setType (std::string const &tp)
 sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ... More...
 
std::string const & type () const
 returns the type of the entry More...
 
bool hasType (std::string const &tp) const
 returns true if the type entry == type More...
 
void setName (std::string const &nam)
 sets the name of the entry More...
 
std::string const & name () const
 name of the entry More...
 
bool hasName (std::string const &nam) const
 checks if the entry name is equal to name More...
 
int id () const
 returns the entry id More...
 
void setId (int i)
 sets the id More...
 
std::string const & extra () const
 retrieves the extra string More...
 
void setExtra (std::string const &s)
 sets the extra string More...
 

Protected Attributes

long m_begin
 the begin of the entry. More...
 
long m_length
 the size of the entry More...
 
std::string m_type
 the entry type More...
 
std::string m_name
 the name More...
 
int m_id
 the identificator More...
 
bool m_parsed
 a bool to store if the entry is or not parsed More...
 
std::string m_extra
 an extra string More...
 

Friends

std::ostream & operator<< (std::ostream &o, WPSEntry const &ent)
 

Detailed Description

basic class to store an entry in a file This contained :

  • its begin and end positions
  • its type, its name and an identificator
  • a flag used to know if the file is or not parsed

Constructor & Destructor Documentation

WPSEntry::WPSEntry ( )
inline

constructor

virtual WPSEntry::~WPSEntry ( )
inlinevirtual

destructor

Member Function Documentation

std::string const& WPSEntry::extra ( ) const
inline

retrieves the extra string

Referenced by WPS8Graph::readBDR().

bool WPSEntry::isParsed ( ) const
inline
bool WPSEntry::operator!= ( const WPSEntry a) const
inline

basic operator!=

bool WPSEntry::operator== ( const WPSEntry a) const
inline

basic operator==

Referenced by operator!=().

void WPSEntry::setExtra ( std::string const &  s)
inline

sets the extra string

Referenced by WPS8Parser::parseHeaderIndexEntryEnd().

void WPSEntry::setName ( std::string const &  nam)
inline

sets the name of the entry

Referenced by WPS8Parser::parseHeaderIndexEntry(), and WPS8Graph::readIBGF().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
WPSEntry const &  ent 
)
friend

Member Data Documentation

long WPSEntry::m_begin
protected

the begin of the entry.

Referenced by begin(), end(), operator==(), setBegin(), setEnd(), and valid().

std::string WPSEntry::m_extra
protected

an extra string

Referenced by extra(), and setExtra().

int WPSEntry::m_id
protected

the identificator

Referenced by id(), operator==(), setId(), and valid().

long WPSEntry::m_length
protected

the size of the entry

Referenced by end(), length(), operator==(), setEnd(), setLength(), and valid().

std::string WPSEntry::m_name
protected

the name

Referenced by hasName(), name(), operator==(), and setName().

bool WPSEntry::m_parsed
mutableprotected

a bool to store if the entry is or not parsed

Referenced by isParsed(), and setParsed().

std::string WPSEntry::m_type
protected

the entry type

Referenced by hasType(), operator==(), setType(), and type().


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

Generated on Sat Jul 29 2017 15:32:23 for libwps by doxygen 1.8.8