#include <NodeImpl.h>

Public Member Functions
void	checkBuffers (const std::vector< SourceDestBuffer > &sdbufs, bool allowMissing)

void	checkImageFileOpen (const char srcFileName, int srcLineNumber, const char srcFunctionName) const

virtual void	checkLeavesInSet (const StringSet &pathNames, NodeImplSharedPtr origin)=0

ImageFileImplSharedPtr	destImageFile ()

ustring	elementName () const

bool	findTerminalPosition (const NodeImplSharedPtr &target, uint64_t &countFromLeft)

virtual NodeImplSharedPtr	get (const ustring &pathName)

ustring	imageFileName () const

bool	isAttached () const

virtual bool	isDefined (const ustring &pathName)=0

bool	isRoot () const

bool	isTypeConstrained ()

virtual bool	isTypeEquivalent (NodeImplSharedPtr ni)=0

NodeImplSharedPtr	parent ()

ustring	pathName () const

ustring	relativePathName (const NodeImplSharedPtr &origin, ustring childPathName=ustring()) const

virtual void	set (const StringList &fields, unsigned level, NodeImplSharedPtr ni, bool autoPathCreate=false)

virtual void	set (const ustring &pathName, NodeImplSharedPtr ni, bool autoPathCreate=false)

virtual void	setAttachedRecursive ()

void	setParent (NodeImplSharedPtr parent, const ustring &elementName)

virtual NodeType	type () const =0

virtual void	writeXml (ImageFileImplSharedPtr imf, CheckedFile &cf, int indent, const char *forcedFieldName=nullptr)=0

virtual	~NodeImpl ()=default

Protected Member Functions
NodeImplSharedPtr	getRoot ()

virtual NodeImplSharedPtr	lookup (const ustring &)

	NodeImpl (ImageFileImplWeakPtr destImageFile)

NodeImpl &	operator= (NodeImpl &n)

Protected Attributes
ImageFileImplWeakPtr	destImageFile_

ustring	elementName_

bool	isAttached_

NodeImplWeakPtr	parent_

Friends
class	CompressedVectorWriterImpl

class	Decoder

class	Encoder

class	StructureNodeImpl

Constructor & Destructor Documentation

◆ ~NodeImpl()

virtual e57::NodeImpl::~NodeImpl ( )

virtualdefault

◆ NodeImpl()

NodeImpl::NodeImpl ( ImageFileImplWeakPtr destImageFile )

protected

References checkImageFileOpen().

Member Function Documentation

◆ checkBuffers()

void NodeImpl::checkBuffers	(	const std::vector< SourceDestBuffer > &	sdbufs,
		bool	allowMissing
	)

this node is prototype of CompressedVector

don't checkImageFileOpen

Check that all buffers are same size

Add each pathName to set, error if already in set (a duplicate pathName in sdbufs)

Check no bad fields in sdbufs

Traverse tree recursively, checking that all nodes are listed in sdbufs

References checkLeavesInSet(), e57::E57_ERROR_BUFFER_DUPLICATE_PATHNAME, e57::E57_ERROR_BUFFER_SIZE_MISMATCH, e57::E57_ERROR_PATH_UNDEFINED, isDefined(), pathName(), and e57::toString().

◆ checkImageFileOpen()

void NodeImpl::checkImageFileOpen	(	const char *	srcFileName,
		int	srcLineNumber,
		const char *	srcFunctionName
	)		const

Throw an exception if destImageFile (destImageFile_) isn't open

References destImageFile(), destImageFile_, and e57::E57_ERROR_IMAGEFILE_NOT_OPEN.

◆ checkLeavesInSet()

virtual void e57::NodeImpl::checkLeavesInSet	(	const StringSet &	pathNames,
		NodeImplSharedPtr	origin
	)

pure virtual

Implemented in e57::BlobNodeImpl, e57::CompressedVectorNodeImpl, e57::FloatNodeImpl, e57::IntegerNodeImpl, e57::ScaledIntegerNodeImpl, e57::StringNodeImpl, and e57::StructureNodeImpl.

Referenced by checkBuffers().

◆ destImageFile()

ImageFileImplSharedPtr NodeImpl::destImageFile ( )

don't checkImageFileOpen

References destImageFile_.

Referenced by e57::BlobNodeImpl::BlobNodeImpl(), checkImageFileOpen(), e57::CompressedVectorNodeImpl::reader(), e57::StructureNodeImpl::set(), e57::CompressedVectorNodeImpl::setCodecs(), e57::CompressedVectorNodeImpl::setPrototype(), e57::BlobNodeImpl::write(), and e57::CompressedVectorNodeImpl::writer().

◆ elementName()

ustring NodeImpl::elementName ( ) const

References checkImageFileOpen(), and elementName_.

Referenced by relativePathName(), e57::StructureNodeImpl::set(), and setParent().

◆ findTerminalPosition()

bool NodeImpl::findTerminalPosition	(	const NodeImplSharedPtr &	target,
		uint64_t &	countFromLeft
	)

don't checkImageFileOpen

Recursively visit child nodes

References e57::StructureNodeImpl::childCount(), e57::E57_BLOB, e57::E57_COMPRESSED_VECTOR, e57::E57_FLOAT, e57::E57_INTEGER, e57::E57_SCALED_INTEGER, e57::E57_STRING, e57::E57_STRUCTURE, e57::E57_VECTOR, and type().

◆ get()

NodeImplSharedPtr NodeImpl::get ( const ustring & pathName )

virtual

This is common virtual function for terminal E57 element types: Integer, ScaledInteger, Float, Blob. The non-terminal types override this virtual function. Only absolute pathNames make any sense here, because the terminal types can't have children, so relative pathNames are illegal.

Forward call to the non-terminal root node

Reimplemented in e57::StructureNodeImpl.

References pathName().

Referenced by draftguitools.gui_trackers.editTracker::move().

◆ getRoot()

NodeImplSharedPtr NodeImpl::getRoot ( )

protected

don't checkImageFileOpen

Referenced by e57::StructureNodeImpl::lookup(), and e57::StructureNodeImpl::set().

◆ imageFileName()

ustring NodeImpl::imageFileName ( ) const

don't checkImageFileOpen

References destImageFile_.

◆ isAttached()

bool NodeImpl::isAttached ( ) const

References checkImageFileOpen(), and isAttached_.

Referenced by e57::CompressedVectorNodeImpl::reader(), e57::BlobNodeImpl::write(), and e57::CompressedVectorNodeImpl::writer().

◆ isDefined()

virtual bool e57::NodeImpl::isDefined ( const ustring & pathName )

pure virtual

Implemented in e57::BlobNodeImpl, e57::CompressedVectorNodeImpl, e57::FloatNodeImpl, e57::IntegerNodeImpl, e57::ScaledIntegerNodeImpl, e57::StringNodeImpl, and e57::StructureNodeImpl.

Referenced by checkBuffers().

◆ isRoot()

bool NodeImpl::isRoot ( ) const

References checkImageFileOpen(), and parent_.

Referenced by e57::StructureNodeImpl::lookup(), parent(), pathName(), relativePathName(), and e57::StructureNodeImpl::writeXml().

◆ isTypeConstrained()

bool NodeImpl::isTypeConstrained ( )

don't checkImageFileOpen A node is type constrained if any of its parents is an homo VECTOR or COMPRESSED_VECTOR with more than one child

We have a parent since we are not root

Downcast to shared_ptr<VectorNodeImpl>

If homogeneous vector and have more than one child, then can't change them

Can't make any type changes to CompressedVector prototype. ??? what if hasn't been written to yet

Didn't find any constraining VECTORs or COMPRESSED_VECTORs in path above us, so our type is not constrained.

References e57::E57_COMPRESSED_VECTOR, and e57::E57_VECTOR.

Referenced by e57::StructureNodeImpl::set().

◆ isTypeEquivalent()

virtual bool e57::NodeImpl::isTypeEquivalent ( NodeImplSharedPtr ni )

pure virtual

Implemented in e57::BlobNodeImpl, e57::CompressedVectorNodeImpl, e57::FloatNodeImpl, e57::IntegerNodeImpl, e57::ScaledIntegerNodeImpl, e57::StringNodeImpl, e57::StructureNodeImpl, and e57::VectorNodeImpl.

◆ lookup()

virtual NodeImplSharedPtr e57::NodeImpl::lookup ( const ustring & )

protectedvirtual

Reimplemented in e57::StructureNodeImpl.

◆ operator=()

NodeImpl & e57::NodeImpl::operator= ( NodeImpl & n )

protected

◆ parent()

NodeImplSharedPtr NodeImpl::parent ( )

If is root, then has self as parent (by convention)

References checkImageFileOpen(), isRoot(), and parent_.

Referenced by PathScripts.PathSimulatorGui.CAMSimTaskUi::accept(), Mod.PartDesign.WizardShaft.Shaft.Shaft::equilibrium(), PathScripts.PathSimulatorGui.CAMSimTaskUi::reject(), e57::StructureNodeImpl::set(), setParent(), and PathScripts.PathOpGui.TaskPanelPage::setParent().

◆ pathName()

ustring NodeImpl::pathName ( ) const

References checkImageFileOpen(), elementName_, isRoot(), and parent_.

Referenced by checkBuffers(), e57::BlobNodeImpl::checkLeavesInSet(), e57::CompressedVectorNodeImpl::checkLeavesInSet(), e57::FloatNodeImpl::checkLeavesInSet(), e57::IntegerNodeImpl::checkLeavesInSet(), e57::ScaledIntegerNodeImpl::checkLeavesInSet(), e57::StringNodeImpl::checkLeavesInSet(), e57::FloatNodeImpl::FloatNodeImpl(), get(), e57::StructureNodeImpl::get(), e57::IntegerNodeImpl::IntegerNodeImpl(), e57::BlobNodeImpl::isDefined(), e57::CompressedVectorNodeImpl::isDefined(), e57::FloatNodeImpl::isDefined(), e57::IntegerNodeImpl::isDefined(), e57::ScaledIntegerNodeImpl::isDefined(), e57::StringNodeImpl::isDefined(), e57::StructureNodeImpl::isDefined(), e57::StructureNodeImpl::lookup(), e57::BlobNodeImpl::read(), e57::ScaledIntegerNodeImpl::ScaledIntegerNodeImpl(), set(), e57::StructureNodeImpl::set(), e57::VectorNodeImpl::set(), e57::CompressedVectorNodeImpl::setCodecs(), setParent(), e57::CompressedVectorNodeImpl::setPrototype(), and e57::BlobNodeImpl::write().

◆ relativePathName()

ustring NodeImpl::relativePathName	(	const NodeImplSharedPtr &	origin,
		ustring	childPathName = `ustring()`
	)		const

Got to top and didn't find origin, must be error

Assemble relativePathName from right to left, recursively

References checkImageFileOpen(), e57::E57_ERROR_INTERNAL, elementName(), elementName_, isRoot(), and parent_.

Referenced by e57::BlobNodeImpl::checkLeavesInSet(), e57::FloatNodeImpl::checkLeavesInSet(), e57::IntegerNodeImpl::checkLeavesInSet(), e57::ScaledIntegerNodeImpl::checkLeavesInSet(), and e57::StringNodeImpl::checkLeavesInSet().

◆ set() [1/2]

void NodeImpl::set	(	const StringList &	fields,
		unsigned	level,
		NodeImplSharedPtr	ni,
		bool	autoPathCreate = `false`
	)

virtual

If get here, then tried to call set(fields...) on NodeImpl that wasn't a StructureNodeImpl, so that's an error

Reimplemented in e57::StructureNodeImpl.

References e57::E57_ERROR_BAD_PATH_NAME.

Referenced by draftguitools.gui_trackers.editTracker::move().

◆ set() [2/2]

void NodeImpl::set	(	const ustring &	pathName,
		NodeImplSharedPtr	ni,
		bool	autoPathCreate = `false`
	)

virtual

This is common virtual function for terminal E57 element types: Integer, ScaledInteger, Float, Blob. The non-terminal types override this virtual function. Only absolute pathNames make any sense here, because the terminal types can't have children, so relative pathNames are illegal.

Forward call to the non-terminal root node

Reimplemented in e57::StructureNodeImpl.

References pathName().

Referenced by draftguitools.gui_trackers.editTracker::move().

◆ setAttachedRecursive()

void NodeImpl::setAttachedRecursive ( )

virtual

Non-terminal node types (Structure, Vector, CompressedVector) will override this virtual function, to mark their children, codecs, prototypes

Reimplemented in e57::CompressedVectorNodeImpl, and e57::StructureNodeImpl.

References isAttached_.

Referenced by setParent().

◆ setParent()

void NodeImpl::setParent	(	NodeImplSharedPtr	parent,
		const ustring &	elementName
	)

don't checkImageFileOpen

First check if our parent_ is already set, throw E57_ERROR_ALREADY_HAS_PARENT The isAttached_ condition is to catch two errors: 1) if user attempts to use the ImageFile root as a child (e.g. root.set("x", root)) 2) if user attempts to reuse codecs or prototype trees of a CompressedVectorNode ??? what if CV not attached yet?

??? does caller do setParent first, so state is not messed up when throw?

If parent is attached then we are attached (and all of our children)

References e57::E57_ERROR_ALREADY_HAS_PARENT, elementName(), elementName_, isAttached_, parent(), parent_, pathName(), and setAttachedRecursive().