Simple binary file (with attached text meta-file) More...

#include <SimpleBinFilter.h>

Inheritance diagram for SimpleBinFilter:

Collaboration diagram for SimpleBinFilter:

Public Member Functions
	SimpleBinFilter ()

virtual CC_FILE_ERROR	loadFile (const QString &filename, ccHObject &container, LoadParameters &parameters) override
	Loads one or more entities from a file. More...

virtual bool	canSave (CV_CLASS_ENUM type, bool &multiple, bool &exclusive) const override
	Returns whether this I/O filter can save the specified type of entity. More...

virtual CC_FILE_ERROR	saveToFile (ccHObject *entity, const QString &filename, const SaveParameters &parameters) override
	Saves an entity (or a group of) to a file. More...

Public Member Functions inherited from FileIOFilter
virtual	~FileIOFilter ()=default

bool	importSupported () const
	Returns whether this I/O filter can import files. More...

bool	exportSupported () const
	Returns whether this I/O filter can export files. More...

const QStringList &	getFileFilters (bool onImport) const
	Returns the file filter(s) for this I/O filter. More...

QString	getDefaultExtension () const
	Returns the default file extension. More...

virtual void	unregister ()
	Called when the filter is unregistered. More...

Additional Inherited Members
Public Types inherited from FileIOFilter
enum	FilterFeature { NoFeatures = 0x0000 , Import = 0x00001 , Export = 0x0002 , BuiltIn = 0x0004 , DynamicInfo = 0x0008 }

using	Shared = QSharedPointer< FileIOFilter >
	Shared type. More...

using	FilterContainer = std::vector< FileIOFilter::Shared >
	Type of a I/O filters container. More...

Static Public Member Functions inherited from FileIOFilter
static QStringList	ImportFilterList ()

static ccHObject *	LoadFromFile (const QString &filename, LoadParameters &parameters, Shared filter, CC_FILE_ERROR &result)
	Loads one or more entities from a file with a known filter. More...

static ccHObject *	LoadFromFile (const QString &filename, LoadParameters &parameters, CC_FILE_ERROR &result, const QString &fileFilter=QString())
	Loads one or more entities from a file with known type. More...

static CC_FILE_ERROR	SaveToFile (ccHObject *entities, const QString &filename, const SaveParameters &parameters, Shared filter)

static CC_FILE_ERROR	SaveToFile (ccHObject *entities, const QString &filename, const SaveParameters &parameters, const QString &fileFilter)

static bool	HandleGlobalShift (const CCVector3d &P, CCVector3d &Pshift, bool &preserveCoordinateShift, LoadParameters &loadParameters, bool useInputCoordinatesShiftIfPossible=false)
	Shortcut to the ecvGlobalShiftManager mechanism specific for files. More...

static void	DisplayErrorMessage (CC_FILE_ERROR err, const QString &action, const QString &filename)
	Displays (to console) the message corresponding to a given error code. More...

static bool	CheckForSpecialChars (const QString &filename)
	Returns whether special characters are present in the input string. More...

static void	ResetSesionCounter ()

static unsigned	IncreaseSesionCounter ()

static void	Register (Shared filter)
	Registers a new filter. More...

static Shared	GetFilter (const QString &fileFilter, bool onImport)
	Returns the filter corresponding to the given 'file filter'. More...

static Shared	FindBestFilterForExtension (const QString &ext)
	Returns the best filter (presumably) to open a given file extension. More...

static const FilterContainer &	GetFilters ()
	Returns the set of all registered filters. More...

static void	UnregisterAll ()
	Unregisters all filters. More...

Protected Member Functions inherited from FileIOFilter
	FileIOFilter (const FilterInfo &info)

void	setImportExtensions (const QStringList &extensions)

void	setImportFileFilterStrings (const QStringList &filterStrings)

void	setExportFileFilterStrings (const QStringList &filterStrings)

Static Protected Attributes inherited from FileIOFilter
static constexpr float	DEFAULT_PRIORITY = 25.0f

Detailed Description

Simple binary file (with attached text meta-file)

Definition at line 13 of file SimpleBinFilter.h.

Constructor & Destructor Documentation

◆ SimpleBinFilter()

SimpleBinFilter::SimpleBinFilter ( )

Definition at line 29 of file SimpleBinFilter.cpp.

References FileIOFilter::Export, and FileIOFilter::Import.

Member Function Documentation

◆ canSave()

bool SimpleBinFilter::canSave	(	CV_CLASS_ENUM	type,
		bool &	multiple,
		bool &	exclusive
	)		const

overridevirtual

Returns whether this I/O filter can save the specified type of entity.

Parameters

type	entity type
multiple	whether the filter can save multiple instances of this entity at once
exclusive	whether the filter can only save this type of entity if selected or if it can be mixed with other types

Returns: whether the entity type can be saved

Reimplemented from FileIOFilter.

Definition at line 37 of file SimpleBinFilter.cpp.

References CV_TYPES::POINT_CLOUD, and type.

◆ loadFile()

CC_FILE_ERROR SimpleBinFilter::loadFile	(	const QString &	filename,
		ccHObject &	container,
		LoadParameters &	parameters
	)

overridevirtual

Loads one or more entities from a file.

This method must be implemented by children classes.

Parameters

filename	file to load
container	container to store loaded entities
parameters	generic loading parameters

Returns: error

Reimplemented from FileIOFilter.

Definition at line 238 of file SimpleBinFilter.cpp.

References ccHObject::addChild(), cloudViewer::ScalarField::addElement(), ecvGlobalShiftManager::ALWAYS_DISPLAY_DIALOG, c_headerSize, QtCompatRegExpOption::CaseInsensitive, CC_FERR_BAD_ARGUMENT, CC_FERR_CANCELED_BY_USER, CC_FERR_MALFORMED_FILE, CC_FERR_NO_ERROR, CC_FERR_NOT_ENOUGH_MEMORY, CC_FERR_READING, FileIOFilter::LoadParameters::coordinatesShiftEnabled, CVLog::Error(), filename, Vector3Tpl< double >::fromArray(), Vector3Tpl< PointCoordinateType >::fromArray(), GlobalDescriptor::globalScale, GlobalDescriptor::globalShift, FileIOFilter::HandleGlobalShift(), SFDescriptor::name, ecvGlobalShiftManager::NO_DIALOG, ecvGlobalShiftManager::NO_DIALOG_AUTO_SHIFT, Vector3Tpl< Type >::norm2(), nProgress, cloudViewer::NormalizedProgress::oneStep(), FileIOFilter::LoadParameters::parentWidget, GlobalDescriptor::pointCount, SFDescriptor::precision, CVLog::Print(), CCShareable::release(), cloudViewer::ScalarField::reserveSafe(), s_headerFlagSBF, ccScalarField::setGlobalShift(), SFDescriptor::sf, GlobalDescriptor::SFs, SFDescriptor::shift, FileIOFilter::LoadParameters::shiftHandlingMode, Tuple3Tpl< Type >::u, CVLog::Warning(), Tuple3Tpl< Type >::x, Tuple3Tpl< Type >::y, and Tuple3Tpl< Type >::z.

◆ saveToFile()

CC_FILE_ERROR SimpleBinFilter::saveToFile	(	ccHObject *	entity,
		const QString &	filename,
		const SaveParameters &	parameters
	)

overridevirtual

Saves an entity (or a group of) to a file.

This method must be implemented by children classes.

Parameters

entity	entity (or group of) to save
filename	filename
parameters	generic saving parameters

Returns: error

Reimplemented from FileIOFilter.

Definition at line 45 of file SimpleBinFilter.cpp.

References c_headerSize, CC_FERR_BAD_ARGUMENT, CC_FERR_CANCELED_BY_USER, CC_FERR_NO_ERROR, CC_FERR_READING, filename, Vector3Tpl< float >::fromArray(), ccShiftedObject::getGlobalScale(), ccScalarField::getGlobalShift(), ccShiftedObject::getGlobalShift(), ccObject::getMetaData(), cloudViewer::PointCloudTpl< T >::getNumberOfScalarFields(), cloudViewer::PointCloudTpl< T >::getPoint(), cloudViewer::PointCloudTpl< T >::getScalarField(), cloudViewer::PointCloudTpl< T >::getScalarFieldName(), cloudViewer::ScalarField::getValue(), ccObject::hasMetaData(), ccPointCloud::hasScalarFields(), ccObject::isA(), Vector3Tpl< Type >::norm2(), nProgress, cloudViewer::NormalizedProgress::oneStep(), FileIOFilter::SaveParameters::parentWidget, CV_TYPES::POINT_CLOUD, CVLog::Print(), s_headerFlagSBF, cloudViewer::PointCloudTpl< T >::size(), ccShiftedObject::toGlobal3d(), ccHObjectCaster::ToPointCloud(), CVLog::Warning(), Tuple3Tpl< Type >::x, Tuple3Tpl< Type >::y, and Tuple3Tpl< Type >::z.

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

/root/ACloudViewer/plugins/core/IO/qCoreIO/include/SimpleBinFilter.h
/root/ACloudViewer/plugins/core/IO/qCoreIO/src/SimpleBinFilter.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimpleBinFilter()

Member Function Documentation

◆ canSave()

◆ loadFile()

◆ saveToFile()