rohdeschwarz  0.2.0
TCPIP socket library for Rohde & Schwarz instrument control
Public Member Functions | List of all members
rohdeschwarz::instruments::vna::DataFormat Class Reference

Object-oriented control of the data transfer format and byte order. More...

#include <data_format.hpp>

Public Member Functions

 DataFormat (Vna *vna)
 Constructor. More...
 
bool isAscii ()
 Queries if data transfer format is ASCII. More...
 
void setAscii ()
 Sets data transfer format to ASCII. More...
 
bool isBinary32Bit ()
 Queries if data transfer format is 32-bit float. More...
 
void setBinary32Bit ()
 Sets data transfer format to 32-bit float. More...
 
bool isBinary64Bit ()
 Queries if data transfer format is 64-bit float. More...
 
void setBinary64Bit ()
 Sets data transfer format to 64-bit float. More...
 
bool isBigEndian ()
 Queries if the byte order for float data transfer is big-endian. More...
 
void setBigEndian ()
 Sets the byte order for float data transfer to big-endian. More...
 
bool isLittleEndian ()
 Queries if the byte order for float data transfer is little-endian. More...
 
void setLittleEndian ()
 Sets the byte order for float data transfer to little-endian. More...
 

Detailed Description

Object-oriented control of the data transfer format and byte order.

There are three possible data transfer formats:

For floats, the possible Byte Orders are:

Definition at line 35 of file data_format.hpp.

Constructor & Destructor Documentation

◆ DataFormat()

DataFormat::DataFormat ( Vna vna)

Constructor.

Parameters
[in]vnaPointer to underlying Vna instance

Definition at line 15 of file data_format.cpp.

Member Function Documentation

◆ isAscii()

bool DataFormat::isAscii ( )

Queries if data transfer format is ASCII.

Definition at line 22 of file data_format.cpp.

◆ isBigEndian()

bool DataFormat::isBigEndian ( )

Queries if the byte order for float data transfer is big-endian.

Definition at line 58 of file data_format.cpp.

◆ isBinary32Bit()

bool DataFormat::isBinary32Bit ( )

Queries if data transfer format is 32-bit float.

Definition at line 34 of file data_format.cpp.

◆ isBinary64Bit()

bool DataFormat::isBinary64Bit ( )

Queries if data transfer format is 64-bit float.

Definition at line 46 of file data_format.cpp.

◆ isLittleEndian()

bool DataFormat::isLittleEndian ( )

Queries if the byte order for float data transfer is little-endian.

Definition at line 70 of file data_format.cpp.

◆ setAscii()

void DataFormat::setAscii ( )

Sets data transfer format to ASCII.

ASCII data is equivalent to CSV format

Definition at line 28 of file data_format.cpp.

◆ setBigEndian()

void DataFormat::setBigEndian ( )

Sets the byte order for float data transfer to big-endian.

Definition at line 64 of file data_format.cpp.

◆ setBinary32Bit()

void DataFormat::setBinary32Bit ( )

Sets data transfer format to 32-bit float.

Data is transferred as 32-bit (4 byte) floating point values with no separator. In C/C++, this corresponds to type float.

Definition at line 40 of file data_format.cpp.

◆ setBinary64Bit()

void DataFormat::setBinary64Bit ( )

Sets data transfer format to 64-bit float.

Data is transferred as 64-bit (8 byte) floating point values with no separator. In C/C++, this corresponds to type double.

Definition at line 52 of file data_format.cpp.

◆ setLittleEndian()

void DataFormat::setLittleEndian ( )

Sets the byte order for float data transfer to little-endian.

Definition at line 76 of file data_format.cpp.


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