PCL
pcl::SexagesimalConversionOptions Struct Reference

Formatting options for string sexagesimal representations. More...

#include <String.h>

+ Inheritance diagram for pcl::SexagesimalConversionOptions:

Public Member Functions

constexpr SexagesimalConversionOptions (unsigned items_=3, unsigned precision_=2, bool sign_=false, unsigned width_=0, char separator_=':', char padding_=' ')
 
 SexagesimalConversionOptions (const SexagesimalConversionOptions &)=default
 
SexagesimalConversionOptionsoperator= (const SexagesimalConversionOptions &)=default
 

Public Attributes

unsigned items: 2
 
char padding
 
unsigned precision: 4
 
char separator
 
bool sign: 1
 
unsigned width: 4
 

Detailed Description

Constructor & Destructor Documentation

◆ SexagesimalConversionOptions() [1/2]

constexpr pcl::SexagesimalConversionOptions::SexagesimalConversionOptions ( unsigned  items_ = 3,
unsigned  precision_ = 2,
bool  sign_ = false,
unsigned  width_ = 0,
char  separator_ = ':',
char  padding_ = ' ' 
)
inline

Default constructor.

Definition at line 203 of file String.h.

◆ SexagesimalConversionOptions() [2/2]

pcl::SexagesimalConversionOptions::SexagesimalConversionOptions ( const SexagesimalConversionOptions )
default

Copy constructor.

Member Function Documentation

◆ operator=()

SexagesimalConversionOptions& pcl::SexagesimalConversionOptions::operator= ( const SexagesimalConversionOptions )
default

Copy assignment operator. Returns a reference to this object.

Member Data Documentation

◆ items

unsigned pcl::SexagesimalConversionOptions::items

Number of represented items. Can be 1, 2 or 3. All items but the last one are represented as integer values. The last item is represented as a floating point value with the specified precision. The default value is three items.

Definition at line 164 of file String.h.

◆ padding

char pcl::SexagesimalConversionOptions::padding

A single character used for padding right-justified representations of first sexagesimal components. See the width member. The default padding character is the white space, ' '.

Definition at line 198 of file String.h.

◆ precision

unsigned pcl::SexagesimalConversionOptions::precision

Number of decimal digits for the last represented sexagesimal item. The default value is two decimal digits.

Definition at line 170 of file String.h.

◆ separator

char pcl::SexagesimalConversionOptions::separator

A single character used for separation of sexagesimal components. The default separator is a colon character, ':'.

Definition at line 191 of file String.h.

◆ sign

bool pcl::SexagesimalConversionOptions::sign

Whether to always prepend a sign character to the first represented item, even '+' for positive values. This is false by default.

Definition at line 176 of file String.h.

◆ width

unsigned pcl::SexagesimalConversionOptions::width

Width of the integer part of the first represented item in characters, including the sign when applicable. When the specified width is larger than the length of the represented item, it is left-padded with padding characters as necessary. The default is zero, which means that no padding is performed for the first item by default.

Definition at line 185 of file String.h.


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