DeviceConnector.h File Reference

Go to the source code of this file.

Classes
struct	RobotRaconteur::Companion::Util::DeviceConnectorDetails
	Device connection information for use with DeviceConnector class. More...
class	RobotRaconteur::Companion::Util::DeviceConnector
	Device connection manager for connecting to devices using Robot Raconteur. More...

Functions
std::vector< DeviceConnectorDetails >	RobotRaconteur::Companion::Util::LoadDeviceDetailsFromFile (const boost::filesystem::path &filename)
	Load DeviceDetails list from a YAML file.
std::vector< DeviceConnectorDetails >	RobotRaconteur::Companion::Util::LoadDeviceDetailsFromString (const std::string &yaml_str)
	Load DeviceDetails list from a YAML string.
std::vector< DeviceConnectorDetails >	RobotRaconteur::Companion::Util::LoadDeviceDetailsFromStream (std::istream &stream)
	Load DeviceDetails list from a YAML stream.
std::vector< DeviceConnectorDetails >	RobotRaconteur::Companion::Util::LoadDeviceDetailsFromYAMLNode (const YAML::Node &node)
	Load DeviceDetails list from a YAML node.

Detailed Description

Author

John Wason, PhD

Copyright

Copyright 2024 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

LoadDeviceDetailsFromFile()

std::vector< DeviceConnectorDetails > RobotRaconteur::Companion::Util::LoadDeviceDetailsFromFile

(

const boost::filesystem::path &

filename

)

Load DeviceDetails list from a YAML file.

See the DeviceConnector documentation for the YAML format

Parameters

filename

The filename to load

Returns

std::vector<DeviceConnectorDetails> The list of device details

LoadDeviceDetailsFromStream()

std::vector< DeviceConnectorDetails > RobotRaconteur::Companion::Util::LoadDeviceDetailsFromStream

(

std::istream &

stream

)

Load DeviceDetails list from a YAML stream.

See the DeviceConnector documentation for the YAML format

Parameters

stream

The YAML formatted stream to load

Returns

std::vector<DeviceConnectorDetails> The list of device details

LoadDeviceDetailsFromString()

std::vector< DeviceConnectorDetails > RobotRaconteur::Companion::Util::LoadDeviceDetailsFromString

(

const std::string &

yaml_str

)

Load DeviceDetails list from a YAML string.

See the DeviceConnector documentation for the YAML format

Parameters

yaml_str

The YAML formatted string to load

Returns

std::vector<DeviceConnectorDetails> The list of device details

LoadDeviceDetailsFromYAMLNode()

std::vector< DeviceConnectorDetails > RobotRaconteur::Companion::Util::LoadDeviceDetailsFromYAMLNode

(

const YAML::Node &

node

)

Load DeviceDetails list from a YAML node.

Load from a pre-parsed YAML::Node

See the DeviceConnector documentation for the YAML format

Parameters

node	The YAML node to load

Returns

std::vector<DeviceConnectorDetails> The list of device details