Represents a single binary data attribute within the protocol. More...

#include <binary.hpp>

Public Member Functions
	BinaryDataAttribute (const std::string &identifier, irsol::types::protocol_value_t value)
	Constructs a BinaryDataAttribute.

std::string	toString () const
	Returns a string representation of the binary data attribute.

bool	hasInt () const

bool	hasDouble () const

bool	hasString () const

Public Attributes
std::string	identifier
	Identifier of the binary data attribute.

irsol::types::protocol_value_t	value
	Value associated with the attribute.

Detailed Description

Represents a single binary data attribute within the protocol.

This struct encapsulates a key-value pair where the key is an identifier and the value is a protocol-specific typed value irsol::types::protocol_value_t.

Definition at line 34 of file binary.hpp.

Constructor & Destructor Documentation

◆ BinaryDataAttribute()

irsol::protocol::BinaryDataAttribute::BinaryDataAttribute	(	const std::string &	identifier,
		irsol::types::protocol_value_t	value
	)

Constructs a BinaryDataAttribute.

Parameters

identifier	The identifier string.
value	The associated protocol value.

Definition at line 10 of file binary.cpp.

13 : identifier(utils::validateIdentifier(identifier)), value(value)

14{}

irsol::protocol::utils::validateIdentifier

std::string validateIdentifier(const std::string &identifier)

Validate that a string is a valid protocol identifier.

Definition utils.hpp:55

irsol::protocol::BinaryDataAttribute::identifier

std::string identifier

Identifier of the binary data attribute.

Definition binary.hpp:44

irsol::protocol::BinaryDataAttribute::value

irsol::types::protocol_value_t value

Value associated with the attribute.

Definition binary.hpp:47

Member Function Documentation

◆ hasDouble()

bool irsol::protocol::BinaryDataAttribute::hasDouble ( ) const

Returns: True if the value holds a double type.

Definition at line 43 of file binary.cpp.

{
  return std::holds_alternative<double>(value);
}

◆ hasInt()

bool irsol::protocol::BinaryDataAttribute::hasInt ( ) const

Returns: True if the value holds an integer type.

Definition at line 37 of file binary.cpp.

{
  return std::holds_alternative<int>(value);
}

◆ hasString()

bool irsol::protocol::BinaryDataAttribute::hasString ( ) const

Returns: True if the value holds a string type.

Definition at line 49 of file binary.cpp.

{
  return std::holds_alternative<std::string>(value);
}

◆ toString()

std::string irsol::protocol::BinaryDataAttribute::toString ( ) const

Returns a string representation of the binary data attribute.

Returns: A string representation of the binary data attribute".

Definition at line 17 of file binary.cpp.

{
  std::ostringstream oss;
  oss << "BinaryDataAttribute{"
      << "identifier: '" << identifier << "', value: ";
  if(hasInt()) {
    oss << "<int> " << std::get<int>(value);
  } else if(hasDouble()) {
    oss << "<double> " << std::get<double>(value);
  } else if(hasString()) {
    oss << "<string> \"" << std::get<std::string>(value) << "\"";
  } else {
    IRSOL_ASSERT_ERROR(false, "Invalid binary data attribute value type");
    throw std::runtime_error("Invalid binary data attribute value type");
  }
  oss << '}';
  return oss.str();
}

Member Data Documentation

◆ identifier

std::string irsol::protocol::BinaryDataAttribute::identifier

Identifier of the binary data attribute.

Definition at line 44 of file binary.hpp.

◆ value

irsol::types::protocol_value_t irsol::protocol::BinaryDataAttribute::value