Ignition Common

API Reference

4.1.0

The fragment component of a URI. More...

#include <URI.hh>

Public Member Functions

 URIFragment ()
 Constructor. More...
 
 URIFragment (const std::string &_str)
 Construct a URIFragment object from a string. More...
 
 URIFragment (const URIFragment &_fragment)
 Copy constructor. More...
 
virtual ~URIFragment ()
 Destructor. More...
 
void Clear ()
 Remove all values of the fragment. More...
 
URIFragmentoperator= (const URIFragment &_fragment)
 Assignment operator. More...
 
URIFragmentoperator= (const std::string &_fragment)
 Assignment operator. More...
 
bool operator== (const URIFragment &_fragment) const
 Return true if the two fragments contain the same values. More...
 
bool Parse (const std::string &_string)
 Parse a string as URIFragment. More...
 
std::string Str () const
 Get the fragment as a string. More...
 
bool Valid () const
 Check if this is a valid URI fragment. More...
 

Static Public Member Functions

static bool Valid (const std::string &_str)
 Check if a string is a valid URI fragment. More...
 

Detailed Description

The fragment component of a URI.

Constructor & Destructor Documentation

◆ URIFragment() [1/3]

Constructor.

◆ URIFragment() [2/3]

URIFragment ( const std::string _str)
explicit

Construct a URIFragment object from a string.

Parameters
[in]_strA string.

◆ URIFragment() [3/3]

URIFragment ( const URIFragment _fragment)

Copy constructor.

Parameters
[in]_fragmentAnother fragment component

◆ ~URIFragment()

virtual ~URIFragment ( )
virtual

Destructor.

Member Function Documentation

◆ Clear()

void Clear ( )

Remove all values of the fragment.

◆ operator=() [1/2]

URIFragment& operator= ( const URIFragment _fragment)

Assignment operator.

Parameters
[in]_fragmentanother URIFragment.
Returns
Itself.

◆ operator=() [2/2]

URIFragment& operator= ( const std::string _fragment)

Assignment operator.

Parameters
[in]_fragmentanother URIFragment.
Returns
Itself.

◆ operator==()

bool operator== ( const URIFragment _fragment) const

Return true if the two fragments contain the same values.

Parameters
[in]_fragmentA URI fragment to compare. return True if the fragments match.

◆ Parse()

bool Parse ( const std::string _string)

Parse a string as URIFragment.

Parameters
[in]_strA string.
Returns
True if the string can be parsed as a URIFragment.

◆ Str()

std::string Str ( ) const

Get the fragment as a string.

Returns
The fragment as a string.

◆ Valid() [1/2]

static bool Valid ( const std::string _str)
static

Check if a string is a valid URI fragment.

Parameters
[in]_strThe string to check.
Returns
True if the string can be parsed as a URI fragment.

◆ Valid() [2/2]

bool Valid ( ) const

Check if this is a valid URI fragment.

Returns
True if this can be parsed as a URI fragment.

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