basic class used to manage RagTime 5/6 zones More...

#include <RagTime5ClusterManager.hxx>

Classes
struct	Cluster
	the cluster data More...
struct	ClusterLayout
	the layout cluster ( 4001 zone) More...
struct	ClusterParser
	virtual class use to parse the cluster data More...
struct	ClusterRoot
	the cluster for root More...
struct	ClusterScript
	the cluster script ( 2/a/4002/400a zone) More...
struct	Link
	a link to a small zone (or set of zones) in RagTime 5/6 documents More...
Public Member Functions
	RagTime5ClusterManager (RagTime5Parser &parser)
	constructor
	~RagTime5ClusterManager ()
	destructor
bool	readCluster (RagTime5Zone &zone, ClusterParser &parser, bool warnForUnparsed=true)
	try to read a cluster zone
bool	readCluster (RagTime5Zone &zone, shared_ptr< Cluster > &cluster, int type=-1)
	try to read a cluster zone
bool	readClusterMainList (ClusterRoot &root, std::vector< int > &list, std::vector< int > const &clusterIdList)
	try to read the cluster root list (in general Data14)
bool	readFieldClusters (Link const &link)
	try to read some field cluster
bool	readUnknownClusterC (Link const &link)
	try to read some unknown cluster
int	getClusterFileType (RagTime5Zone &zone)
	try to find a cluster zone type ( heuristic when the cluster type is unknown )
int	getClusterType (RagTime5Zone &zone, int fileType)
	returns the local zone type
bool	getClusterBasicHeaderInfo (RagTime5Zone &zone, long &N, long &fSz, long &debHeaderPos)
	try to return basic information about the header cluster's zone
bool	readFieldHeader (RagTime5Zone &zone, long endPos, std::string const &headerName, long &endDataPos, long expectedLVal=-99999)
	try to read a field header, if ok set the endDataPos positions
std::string	getClusterName (int id)
	returns "data"+id+"A" ( followed by the cluster type and name if know)
Protected Attributes
shared_ptr < RagTime5ClusterManagerInternal::State >	m_state
	the state
RagTime5Parser &	m_mainParser
	the main parser
shared_ptr< RagTime5StructManager >	m_structManager
	the structure manager
Private Member Functions
	RagTime5ClusterManager (RagTime5ClusterManager const &orig)
RagTime5ClusterManager	operator= (RagTime5ClusterManager const &orig)
Friends
struct	ClusterParser

Detailed Description

basic class used to manage RagTime 5/6 zones

Constructor & Destructor Documentation

RagTime5ClusterManager::RagTime5ClusterManager ( RagTime5Parser & parser )

constructor

RagTime5ClusterManager::~RagTime5ClusterManager ( )

destructor

RagTime5ClusterManager::RagTime5ClusterManager ( RagTime5ClusterManager const & orig ) [private]

Member Function Documentation

bool RagTime5ClusterManager::getClusterBasicHeaderInfo	(	RagTime5Zone &	zone,
		long &	N,
		long &	fSz,
		long &	debHeaderPos
	)

try to return basic information about the header cluster's zone

Referenced by getClusterFileType(), and getClusterType().

int RagTime5ClusterManager::getClusterFileType ( RagTime5Zone & zone )

try to find a cluster zone type ( heuristic when the cluster type is unknown )

Referenced by getClusterType(), readCluster(), and readClusterMainList().

std::string RagTime5ClusterManager::getClusterName ( int id )

returns "data"+id+"A" ( followed by the cluster type and name if know)

Referenced by RagTime5GraphInternal::ClustListParser::getClusterName(), RagTime5SpreadsheetInternal::ClustListParser::getClusterName(), RagTime5TextInternal::ClustListParser::getClusterName(), RagTime5ParserInternal::ClustListParser::getClusterName(), RagTime5ClusterManager::ClusterParser::getClusterName(), RagTime5ClusterManagerInternal::LayoutCParser::parseHeaderZone(), RagTime5ClusterManagerInternal::ColPatCParser::parseZone(), RagTime5ClusterManagerInternal::LayoutCParser::parseZone(), RagTime5ClusterManagerInternal::PipelineCParser::parseZone(), and RagTime5ClusterManagerInternal::LayoutCParser::parseZoneBlock().

int RagTime5ClusterManager::getClusterType	(	RagTime5Zone &	zone,
		int	fileType
	)

returns the local zone type

Referenced by readCluster(), and readClusterMainList().

RagTime5ClusterManager RagTime5ClusterManager::operator= ( RagTime5ClusterManager const & orig ) [private]

bool RagTime5ClusterManager::readCluster	(	RagTime5Zone &	zone,
		RagTime5ClusterManager::ClusterParser &	parser,
		bool	warnForUnparsed = `true`
	)

try to read a cluster zone

Referenced by readCluster().

bool RagTime5ClusterManager::readCluster	(	RagTime5Zone &	zone,
		shared_ptr< Cluster > &	cluster,
		int	type = `-1`
	)

try to read a cluster zone

bool RagTime5ClusterManager::readClusterMainList	(	RagTime5ClusterManager::ClusterRoot &	root,
		std::vector< int > &	list,
		std::vector< int > const &	clusterIdList
	)

try to read the cluster root list (in general Data14)

bool RagTime5ClusterManager::readFieldClusters ( Link const & link )

try to read some field cluster

bool RagTime5ClusterManager::readFieldHeader	(	RagTime5Zone &	zone,
		long	endPos,
		std::string const &	headerName,
		long &	endDataPos,
		long	expectedLVal = `-99999`
	)