Ocean Devices Serialization Library

The Ocean Devices Serialization Library provides serialization and deserialization functionality for device samples. More...

Collaboration diagram for Ocean Devices Serialization Library:

Data Structures
class	Ocean::Devices::Serialization::DeviceSerializer
	This class provides serialization capabilities for devices. More...
class	Ocean::Devices::Serialization::SerializationAccelerationSensor3DOF
	This class implements a Serialization 3DOF acceleration sensor. More...
class	Ocean::Devices::Serialization::SerializationFactory
	This class implements a device factory for the Serialization library. More...
class	Ocean::Devices::Serialization::SerializationGPSTracker
	This class implements a Serialization GPS tracker. More...
class	Ocean::Devices::Serialization::SerializationGravityTracker3DOF
	This class implements a Serialization 3DOF gravity tracker. More...
class	Ocean::Devices::Serialization::SerializationGyroSensor3DOF
	This class implements a Serialization 3DOF gyro sensor. More...
class	Ocean::Devices::Serialization::SerializationOrientationTracker3DOF
	This class implements a Serialization 3DOF orientation tracker. More...
class	Ocean::Devices::Serialization::SerializationPositionTracker3DOF
	This class implements a Serialization 3DOF position tracker. More...
class	Ocean::Devices::Serialization::SerializationSensor
	This class implements a Serialization sensor. More...
class	Ocean::Devices::Serialization::SerializationTracker
	This class implements a Serialization tracker. More...
class	Ocean::Devices::Serialization::SerializationTracker6DOF
	This class implements a Serialization 6DOF tracker. More...
class	Ocean::Devices::Serialization::SerializerDevicePlayer
	This class implements a player for device objects based on Ocean's DataSerializer. More...
class	Ocean::Devices::Serialization::SerializerDeviceRecorder
	This class implements a serialization recorder for devices and media objects. More...

Typedefs
using	Ocean::Devices::Serialization::SerializationAccelerationSensor3DOFRef = SmartDeviceRef< SerializationAccelerationSensor3DOF >
	Definition of a smart object reference for a Serialization 3DOF acceleration sensor.
using	Ocean::Devices::Serialization::SerializationGPSTrackerRef = SmartDeviceRef< SerializationGPSTracker >
	Definition of a smart object reference for a Serialization GPS tracker.
using	Ocean::Devices::Serialization::SerializationGravityTracker3DOFRef = SmartDeviceRef< SerializationGravityTracker3DOF >
	Definition of a smart object reference for a Serialization 3DOF gravity tracker.
using	Ocean::Devices::Serialization::SerializationGyroSensor3DOFRef = SmartDeviceRef< SerializationGyroSensor3DOF >
	Definition of a smart object reference for a Serialization 3DOF gyro sensor.
using	Ocean::Devices::Serialization::SerializationOrientationTracker3DOFRef = SmartDeviceRef< SerializationOrientationTracker3DOF >
	Definition of a smart object reference for a Serialization 3DOF orientation tracker.
using	Ocean::Devices::Serialization::SerializationPositionTracker3DOFRef = SmartDeviceRef< SerializationPositionTracker3DOF >
	Definition of a smart object reference for a Serialization 3DOF position tracker.
using	Ocean::Devices::Serialization::SerializationSensorRef = SmartDeviceRef< SerializationSensor >
	Definition of a smart object reference for a Serialization sensor.
using	Ocean::Devices::Serialization::SerializationTrackerRef = SmartDeviceRef< SerializationTracker >
	Definition of a smart object reference for a Serialization tracker.
using	Ocean::Devices::Serialization::SerializationTracker6DOFRef = SmartDeviceRef< SerializationTracker6DOF >
	Definition of a smart object reference for a Serialization 6DOF tracker.

Functions
bool OCEAN_DEVICES_SERIALIZATION_EXPORT	pluginLoad ()
	Tries to load the plugin and initializes all internal 3rd party libraries.
bool OCEAN_DEVICES_SERIALIZATION_EXPORT	pluginUnload ()
	Tries to unload the plugin and all internal resources of 3rd party libraries.
OCEAN_DEVICES_SERIALIZATION_EXPORT std::string	Ocean::Devices::Serialization::nameSerializationLibrary ()
	Returns the name of this devices library.
void	Ocean::Devices::Serialization::registerSerializationLibrary ()
	Registers this Serialization device library at the global device manager.
bool	Ocean::Devices::Serialization::unregisterSerializationLibrary ()
	Unregisters this Serialization device library at the global device manager.

Detailed Description

The Ocean Devices Serialization Library provides serialization and deserialization functionality for device samples.

This library enables device measurements to be stored to and loaded from binary streams using the DataSerializer framework.

The library supports serialization of various device types including:

• AccelerationSensor3DOF: 3-DOF acceleration sensor measurements
• GyroSensor3DOF: 3-DOF gyro sensor measurements
• GravityTracker3DOF: 3-DOF gravity tracker measurements
• OrientationTracker3DOF: 3-DOF orientation tracker measurements
• PositionTracker3DOF: 3-DOF position tracker measurements
• Tracker6DOF: 6-DOF tracker measurements (orientation + position)
• GPSTracker: GPS location measurements

Typedef Documentation

SerializationAccelerationSensor3DOFRef

using Ocean::Devices::Serialization::SerializationAccelerationSensor3DOFRef = typedef SmartDeviceRef<SerializationAccelerationSensor3DOF>

Definition of a smart object reference for a Serialization 3DOF acceleration sensor.

See also

SerializationAccelerationSensor3DOF.

SerializationGPSTrackerRef

using Ocean::Devices::Serialization::SerializationGPSTrackerRef = typedef SmartDeviceRef<SerializationGPSTracker>

Definition of a smart object reference for a Serialization GPS tracker.

See also

SerializationGPSTracker.

SerializationGravityTracker3DOFRef

using Ocean::Devices::Serialization::SerializationGravityTracker3DOFRef = typedef SmartDeviceRef<SerializationGravityTracker3DOF>

Definition of a smart object reference for a Serialization 3DOF gravity tracker.

See also

SerializationGravityTracker3DOF.

SerializationGyroSensor3DOFRef

using Ocean::Devices::Serialization::SerializationGyroSensor3DOFRef = typedef SmartDeviceRef<SerializationGyroSensor3DOF>

Definition of a smart object reference for a Serialization 3DOF gyro sensor.

See also

SerializationGyroSensor3DOF.

SerializationOrientationTracker3DOFRef

using Ocean::Devices::Serialization::SerializationOrientationTracker3DOFRef = typedef SmartDeviceRef<SerializationOrientationTracker3DOF>

Definition of a smart object reference for a Serialization 3DOF orientation tracker.

See also

SerializationOrientationTracker3DOF.

SerializationPositionTracker3DOFRef

using Ocean::Devices::Serialization::SerializationPositionTracker3DOFRef = typedef SmartDeviceRef<SerializationPositionTracker3DOF>

Definition of a smart object reference for a Serialization 3DOF position tracker.

See also

SerializationPositionTracker3DOF.

SerializationSensorRef

using Ocean::Devices::Serialization::SerializationSensorRef = typedef SmartDeviceRef<SerializationSensor>

Definition of a smart object reference for a Serialization sensor.

See also

SerializationSensor.

SerializationTracker6DOFRef

using Ocean::Devices::Serialization::SerializationTracker6DOFRef = typedef SmartDeviceRef<SerializationTracker6DOF>

Definition of a smart object reference for a Serialization 6DOF tracker.

See also

SerializationTracker6DOF.

SerializationTrackerRef

using Ocean::Devices::Serialization::SerializationTrackerRef = typedef SmartDeviceRef<SerializationTracker>

Definition of a smart object reference for a Serialization tracker.

See also

SerializationTracker.

Function Documentation

nameSerializationLibrary()

OCEAN_DEVICES_SERIALIZATION_EXPORT std::string Ocean::Devices::Serialization::nameSerializationLibrary

(

)

Returns the name of this devices library.

pluginLoad()

bool OCEAN_DEVICES_SERIALIZATION_EXPORT pluginLoad

(

)

Tries to load the plugin and initializes all internal 3rd party libraries.

Make sure that the plugin will be loaded only once!

Returns

True, if succeeded

See also

pluginUnload().

pluginUnload()

bool OCEAN_DEVICES_SERIALIZATION_EXPORT pluginUnload

(

)

Tries to unload the plugin and all internal resources of 3rd party libraries.

Make sure that all resources of this plugin has been released before!

Returns

True, if succeeded

See also

pluginLoad().

registerSerializationLibrary()

void Ocean::Devices::Serialization::registerSerializationLibrary

(

)

Registers this Serialization device library at the global device manager.

This function calls SerializationFactory::registerFactory() only.

unregisterSerializationLibrary()

bool Ocean::Devices::Serialization::unregisterSerializationLibrary

(

)

Unregisters this Serialization device library at the global device manager.

This function calls SerializationFactory::unregisterFactory() only.

Returns

True, if succeeded