pcl::XISFFileSignature Struct Reference

XISF monolithic file signature More...

#include <XISF.h>

Public Member Functions
	XISFFileSignature ()=default
	XISFFileSignature (const XISFFileSignature &)=default
	XISFFileSignature (uint32 length)
XISFFileSignature &	operator= (const XISFFileSignature &)=default
void	Validate () const

Detailed Description

All XISF version 1.0 monolithic files begin with the following sequence:

XISF0100<header-length><reserved>

where 'XISF0100' is the 'magic marker' identifying the format, and <header-length> is the size in bytes of the XML file header encoded as a 32-bit unsigned integer with little-endian byte order. <reserved> is a 32-bit integer reserved for future use; it must be zero. After the file signature sequence comes the XML header and all attached blocks.

Definition at line 719 of file XISF.h.

Constructor & Destructor Documentation

XISFFileSignature() [1/3]

pcl::XISFFileSignature::XISFFileSignature ( )

default

Default constructor. Yields an invalid XISF signature that cannot be used without explicit initialization.

XISFFileSignature() [2/3]

pcl::XISFFileSignature::XISFFileSignature ( const XISFFileSignature &  )

default

Copy constructor.

XISFFileSignature() [3/3]

pcl::XISFFileSignature::XISFFileSignature ( uint32  length )

inline

Constructs a monolithic XISF file signature initialized for the specified header length.

Definition at line 745 of file XISF.h.

Member Function Documentation

operator=()

XISFFileSignature& pcl::XISFFileSignature::operator= ( const XISFFileSignature &  )

default

Copy assignment operator. Returns a reference to this object.

Validate()

void pcl::XISFFileSignature::Validate

(

)

const

Validates this monolithic XISF file signature. Throws an Error exception if it is not valid.

---

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

• XISF.h