gem::sense::IMagneticField Class Reference

Definition of Magnetic field interface. More...

Inheritance diagram for gem::sense::IMagneticField:

Collaboration diagram for gem::sense::IMagneticField:

Public Member Functions
virtual double	getX () const =0
virtual double	getY () const =0
virtual double	getZ () const =0
EDataType	getType () const override final
	Get data type.
virtual LargeInteger	getAcquisitionTimestamp () const=0
Time	getTime () const
StrongPointer< TDerivedType >	cast ()
	Cast to a derived type.

Static Public Member Functions
static bool	isSameType (const IData *ptr)
	Check if two data elements have the same type.

Detailed Description

Definition of Magnetic field interface.

Member Function Documentation

cast()

StrongPointer< TDerivedType > gem::sense::IData::cast ( )

inlineinherited

Cast to a derived type.

Returns

The requested derived type as a shared pointer.

getAcquisitionTimestamp()

virtual LargeInteger gem::sense::IData::getAcquisitionTimestamp ( ) const

pure virtualinherited

Returns

Acquisition timestamp in milliseconds since 1970 ( epoch )

getTime()

Time gem::sense::IData::getTime ( ) const

inlineinherited

Returns

System acquisition time

getType()

EDataType gem::sense::IDataWithType< DerivedType >::getType ( ) const

inlinefinaloverridevirtualinherited

Get data type.

Returns

The data type.

Implements gem::sense::IData.

getX()

virtual double gem::sense::IMagneticField::getX ( ) const

pure virtual

Returns

Magnetic field along the x axis of the device, uT.

getY()

virtual double gem::sense::IMagneticField::getY ( ) const

pure virtual

Returns

Magnetic field along the y axis of the device, uT.

getZ()

virtual double gem::sense::IMagneticField::getZ ( ) const

pure virtual

Returns

Magnetic field along the z axis of the device, uT.

isSameType()

bool gem::sense::IDataWithType< DerivedType >::isSameType ( const IData * ptr )

inlinestaticinherited

Check if two data elements have the same type.

Parameters

ptr	The other IData pointer to check against.

Returns

True if of same type, false if not.