Blob Class Reference

Namespace	ohm::flip
Inherits from	ohm::flip::Object
Declared in	ohm/flip/Blob.h
Companion Guide	Flip Programming Guide: Writing a Flip Class Part 1
	Flip Programming Guide: Using Blobs

Overview

The Blob class implements a Flip class holding an opaque piece of data. The following sections will only document the public API.

Methods Overview

Methods

ctor

Sets the value at post construction stage.

virtual void   ctor (ohm::flip::Args & args);
void           ctor (const archi::UByte * data_ptr, size_t data_size);

The first version sets the value from a cascaded arguments object ohm::flip::Args

set

Sets the data.

void           set (const archi::UByte * data_ptr, size_t data_size);
void           set (const std::string & str);

The second version is a convenient function that transform a std::string in an opaque data type and set it to this. It is usually used in conjonction with the Encoder_ESCAPED_ASCII using push_encoder_escaped_ascii .

clear

Empties the data.

void           clear ();

This convenient function is an alias of set (0, 0) .

subset

Sets a part of the data, leaving the rest untouched.

void           subset (size_t data_pos, const archi::UByte * data_ptr, size_t data_size);

The function will replace the data in the range [data_pos; data_pos + data_size) by the data [data_ptr; data_ptr + data_size)

get

Returns the data of this .

const Data &   get () const;

WARNING:it is invalid to call this function when the object is being restored

to_string

Convenient function that returns the data of this as a std::string .

std::string    to_string () const;

WARNING:The to_string method returns the string by value, not by reference.

WARNING:it is invalid to call this function when the object is being restored

get_old_data

Returns the old data of this .

const Data &   get_old_data () const;

WARNING:it is invalid to call this function when the object is being inited

empty

Convenient function that returns true if data of this is empty, false otherwise.

bool           empty () const;

WARNING:it is invalid to call this function when the object is being restored

size

Convenient function that returns the size of the data of this .

size_t         size () const;

WARNING:it is invalid to call this function when the object is being restored

did_data_change

Returns true if the old data is different from the current data.

bool           did_data_change () const;

Note:Outside of an observer document_changed call, this will always return false

push_encoder

Push an encoder to encoder stack of this to indicates to the back-end writer how the data should be written.

void           push_encoder (Encoder encoder);