RagTime5Pipeline Class Reference

the main class to read the text part of RagTime 56 file More...

#include <RagTime5Pipeline.hxx>

Public Member Functions

 RagTime5Pipeline (RagTime5Document &doc)
 constructor More...
 
virtual ~RagTime5Pipeline ()
 destructor More...
 
int version () const
 returns the file version More...
 

Static Public Member Functions

static std::string printType (unsigned long fileType)
 debug: print a file type More...
 

Protected Member Functions

void flushExtra ()
 sends the data which have not yet been sent to the listener More...
 
std::shared_ptr< RagTime5ClusterManager::ClusterreadPipelineCluster (RagTime5Zone &zone, int zoneType)
 try to read a pipeline cluster More...
 
RagTime5ClusterManager::Cluster::Type getContainerType (int pipelineId) const
 try to return the container's type corresponding to an id More...
 
bool send (int pipelineId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, double totalWidth=-1)
 try to send the container corresponding to pipelineId (mainly unimplemented) More...
 

Protected Attributes

RagTime5Documentm_document
 the parser More...
 
std::shared_ptr< RagTime5StructManagerm_structManager
 the structure manager More...
 
MWAWParserStatePtr m_parserState
 the parser state More...
 
std::shared_ptr< RagTime5PipelineInternal::Statem_state
 the state More...
 

Private Member Functions

 RagTime5Pipeline (RagTime5Pipeline const &orig)=delete
 
RagTime5Pipelineoperator= (RagTime5Pipeline const &orig)=delete
 

Friends

class RagTime5Document
 

Detailed Description

the main class to read the text part of RagTime 56 file

Constructor & Destructor Documentation

RagTime5Pipeline::RagTime5Pipeline ( RagTime5Document doc)
explicit

constructor

RagTime5Pipeline::~RagTime5Pipeline ( )
virtual

destructor

RagTime5Pipeline::RagTime5Pipeline ( RagTime5Pipeline const &  orig)
privatedelete

Member Function Documentation

void RagTime5Pipeline::flushExtra ( )
protected

sends the data which have not yet been sent to the listener

RagTime5ClusterManager::Cluster::Type RagTime5Pipeline::getContainerType ( int  pipelineId) const
protected

try to return the container's type corresponding to an id

RagTime5Pipeline& RagTime5Pipeline::operator= ( RagTime5Pipeline const &  orig)
privatedelete
static std::string RagTime5Pipeline::printType ( unsigned long  fileType)
inlinestatic

debug: print a file type

std::shared_ptr< RagTime5ClusterManager::Cluster > RagTime5Pipeline::readPipelineCluster ( RagTime5Zone zone,
int  zoneType 
)
protected

try to read a pipeline cluster

bool RagTime5Pipeline::send ( int  pipelineId,
MWAWListenerPtr  listener,
MWAWPosition const &  pos,
int  partId = 0,
double  totalWidth = -1 
)
protected

try to send the container corresponding to pipelineId (mainly unimplemented)

int RagTime5Pipeline::version ( ) const

returns the file version

Friends And Related Function Documentation

friend class RagTime5Document
friend

Member Data Documentation

RagTime5Document& RagTime5Pipeline::m_document
protected

the parser

Referenced by getContainerType(), readPipelineCluster(), and send().

MWAWParserStatePtr RagTime5Pipeline::m_parserState
protected

the parser state

Referenced by version().

std::shared_ptr<RagTime5PipelineInternal::State> RagTime5Pipeline::m_state
protected

the state

Referenced by getContainerType(), readPipelineCluster(), and send().

std::shared_ptr<RagTime5StructManager> RagTime5Pipeline::m_structManager
protected

the structure manager


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

Generated on Sat Aug 21 2021 18:43:37 for libmwaw by doxygen 1.8.10