pcl::PropertyDescription Class Reference

A structure to describe a data property. More...

#include <PropertyDescription.h>

Public Types
using	data_type = VariantType::value_type

Public Member Functions
	PropertyDescription ()=default
	PropertyDescription (const IsoString &s, data_type t=VariantType::Invalid)
	PropertyDescription (const PropertyDescription &)=default
bool	IsValid () const
bool	operator< (const PropertyDescription &x) const
PropertyDescription &	operator= (const PropertyDescription &)=default
bool	operator== (const PropertyDescription &x) const

Public Attributes
IsoString	id
	Identifier of this property.
data_type	type = VariantType::Invalid
	Property data type.

Detailed Description

This structure is used (instantiated in PropertyDescriptionArray containers) by the FileFormatImplementation and FileFormaInstance classes to describe data properties stored in image files, among other classes.

See also

FileFormatImplementation, FileFormatInstance

Definition at line 77 of file PropertyDescription.h.

Member Typedef Documentation

data_type

using pcl::PropertyDescription::data_type = VariantType::value_type

An enumeration of supported property data types.

Definition at line 82 of file PropertyDescription.h.

Constructor & Destructor Documentation

PropertyDescription() [1/3]

pcl::PropertyDescription::PropertyDescription ( )

default

Default constructor. Constructs an PropertyDescription object with an empty property identifier and unspecified (invalid) data type.

PropertyDescription() [2/3]

pcl::PropertyDescription::PropertyDescription ( const IsoString &  s, data_type  t = VariantType::Invalid  )

inline

Constructs an PropertyDescription object with the specified property identifier and data type.

Definition at line 97 of file PropertyDescription.h.

PropertyDescription() [3/3]

pcl::PropertyDescription::PropertyDescription ( const PropertyDescription &  )

default

Copy constructor.

Member Function Documentation

IsValid()

bool pcl::PropertyDescription::IsValid ( ) const

inline

Returns true iff this object represents a valid data property.

Definition at line 116 of file PropertyDescription.h.

operator<()

bool pcl::PropertyDescription::operator< ( const PropertyDescription &  x ) const

inline

Less-than relational operator. Returns true if this object precedes the specified object x; otherwise returns false.

Since property identifiers are unique within a property's scope (within an image file, for example), comparisons of PropertyDescription structures only take into account the PropertyDescription::id member.

Definition at line 129 of file PropertyDescription.h.

References id.

operator=()

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

default

Copy assignment operator. Returns a reference to this object.

operator==()

bool pcl::PropertyDescription::operator== ( const PropertyDescription &  x ) const

inline

Equality operator. Returns true if this object refers to the same property as the specified object x; otherwise returns false.

Since property identifiers are unique within a property's scope (within an image file, for example), comparisons of PropertyDescription structures only take into account the PropertyDescription::id member.

Definition at line 142 of file PropertyDescription.h.

References id.

---

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

• PropertyDescription.h