UuidUtil.h File Reference

Go to the source code of this file.

Functions
com::robotraconteur::uuid::UUID	RobotRaconteur::Companion::Util::ParseUuid (const std::string &string_uuid)
std::string	RobotRaconteur::Companion::Util::UuidToString (com::robotraconteur::uuid::UUID uuid)
com::robotraconteur::uuid::UUID	RobotRaconteur::Companion::Util::BoostUuidToUuid (const boost::uuids::uuid &boost_uuid)
boost::uuids::uuid	RobotRaconteur::Companion::Util::UuidToBoostUuid (const com::robotraconteur::uuid::UUID &uuid)
com::robotraconteur::uuid::UUID	RobotRaconteur::Companion::Util::NewRandomUuid ()
	Generate a new random UUID.

Detailed Description

Author

John Wason, PhD

Copyright

Copyright 2023 Wason Technology, LLC

License

Software License Agreement (Apache License)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Function Documentation

BoostUuidToUuid()

com::robotraconteur::uuid::UUID RobotRaconteur::Companion::Util::BoostUuidToUuid

(

const boost::uuids::uuid &

boost_uuid

)

Convert a boost::uuids::uuid to com::robotraconteur::uuid::UUID.

Converts a boost::uuids::uuid object to a com::robotraconteur::uuid::UUID object.

Parameters

boost_uuid

The boost::uuids::uuid to convert.

Returns

The converted UUID.

NewRandomUuid()

com::robotraconteur::uuid::UUID RobotRaconteur::Companion::Util::NewRandomUuid

(

)

Generate a new random UUID.

Generates a new random UUID using boost::uuids::random_generator().

Returns

com::robotraconteur::uuid::UUID The generated random UUID

ParseUuid()

com::robotraconteur::uuid::UUID RobotRaconteur::Companion::Util::ParseUuid

(

const std::string &

string_uuid

)

Parse a UUID from a string.

Parses a string representation of a UUID and returns a com::robotraconteur::uuid::UUID object.

Parameters

string_uuid

The string to parse.

Returns

The parsed UUID.

UuidToBoostUuid()

boost::uuids::uuid RobotRaconteur::Companion::Util::UuidToBoostUuid

(

const com::robotraconteur::uuid::UUID &

uuid

)

Convert a com::robotraconteur::uuid::UUID to boost::uuids::uuid.

Converts a com::robotraconteur::uuid::UUID object to a boost::uuids::uuid object.

Parameters

uuid	The com::robotraconteur::uuid::UUID to convert.

Returns

The converted boost::uuids::uuid.

UuidToString()

std::string RobotRaconteur::Companion::Util::UuidToString

(

com::robotraconteur::uuid::UUID

uuid

)

Convert a UUID to a string.

Converts a com::robotraconteur::uuid::UUID object into a string representation.

Parameters

uuid	The UUID to convert.

Returns

The string representation of the UUID.