Provides a base class for defining DCCL field encoders / decoders. Most users who wish to define custom encoders/decoders will use the RepeatedTypedFieldCodec, TypedFieldCodec or its children (e.g. TypedFixedFieldCodec) instead of directly inheriting from this class. More...

#include <dccl/field_codec.h>

Inheritance diagram for dccl::FieldCodecBase:

[legend]

Public Member Functions
Constructor, Destructor
Base message functions
These are called typically by Codec to start processing a new message. In this example "Foo" is a base message: message Foo { int32 bar = 1; FooBar baz = 2; } dccl::int32 google::protobuf::int32 int32 a signed 32 bit integer Definition common.h:58
void	base_encode (Bitset *bits, const google::protobuf::Message &msg, MessagePart part, bool strict)
	Encode this part (body or head) of the base message.

void	base_size (unsigned *bit_size, const google::protobuf::Message &msg, MessagePart part)
	Calculate the size (in bits) of a part of the base message when it is encoded.

void	base_decode (Bitset bits, google::protobuf::Message msg, MessagePart part)
	Decode part of a message.

void	base_max_size (unsigned bit_size, const google::protobuf::Descriptor desc, MessagePart part)
	Calculate the maximum size of a message given its Descriptor alone (no data)

void	base_min_size (unsigned bit_size, const google::protobuf::Descriptor desc, MessagePart part)
	Calculate the minimum size of a message given its Descriptor alone (no data)

void	base_validate (const google::protobuf::Descriptor *desc, MessagePart part)
	Validate this part of the message to make sure all required extensions are set.

void	base_info (std::ostream os, const google::protobuf::Descriptor desc, MessagePart part)
	Get human readable information (size of fields, etc.) about this part of the DCCL message.

void	base_hash (std::size_t hash, const google::protobuf::Descriptor desc, MessagePart part)
	Provide a hash of the DCCL message definition to detect changes in the DCCL message.

Field functions (primitive types and embedded messages)
class	FieldCodecManagerLocal

struct	BaseRAII

void	field_pre_encode (dccl::any *wire_value, const dccl::any &field_value)
	Pre-encodes a non-repeated (i.e. optional or required) field by converting the FieldType representation (the Google Protobuf representation) into the WireType representation (the type used in the encoded DCCL message). This allows for type-converting codecs.

void	field_pre_encode_repeated (std::vector< dccl::any > *wire_values, const std::vector< dccl::any > &field_values)
	Pre-encodes a repeated field.

void	field_encode (Bitset bits, const dccl::any &field_value, const google::protobuf::FieldDescriptor field)
	Encode a non-repeated field.

void	field_encode_repeated (Bitset bits, const std::vector< dccl::any > &field_values, const google::protobuf::FieldDescriptor field)
	Encode a repeated field.

void	field_size (unsigned bit_size, const dccl::any &field_value, const google::protobuf::FieldDescriptor field)
	Calculate the size of a field.

void	field_size_repeated (unsigned bit_size, const std::vector< dccl::any > &field_values, const google::protobuf::FieldDescriptor field)
	Calculate the size of a repeated field.

void	field_decode (Bitset bits, dccl::any field_value, const google::protobuf::FieldDescriptor *field)
	Decode a non-repeated field.

void	field_decode_repeated (Bitset bits, std::vector< dccl::any > field_values, const google::protobuf::FieldDescriptor *field)
	Decode a repeated field.

void	field_post_decode (const dccl::any &wire_value, dccl::any *field_value)
	Post-decodes a non-repeated (i.e. optional or required) field by converting the WireType (the type used in the encoded DCCL message) representation into the FieldType representation (the Google Protobuf representation). This allows for type-converting codecs.

void	field_post_decode_repeated (const std::vector< dccl::any > &wire_values, std::vector< dccl::any > *field_values)
	Post-decodes a repeated field.

void	field_max_size (unsigned bit_size, const google::protobuf::FieldDescriptor field)
	Calculate the upper bound on this field's size (in bits)

void	field_min_size (unsigned bit_size, const google::protobuf::FieldDescriptor field)
	Calculate the lower bound on this field's size (in bits)

void	field_validate (bool b, const google::protobuf::FieldDescriptor field)
	Validate this field, checking that all required option extensions are set (e.g. (dccl.field).max and (dccl.field).min for arithmetic codecs)

void	field_info (std::ostream os, const google::protobuf::FieldDescriptor field)
	Write human readable information about the field and its bounds to the provided stream.

void	field_hash (std::size_t hash, const google::protobuf::FieldDescriptor field)
	Provide a hash for this field definition.

dccl::DCCLFieldOptions	dccl_field_options () const
	Get the DCCL field option extension value for the current field.

void	require (bool b, const std::string &description)
	Essentially an assertion to be used in the validate() virtual method.

DynamicConditions &	dynamic_conditions (const google::protobuf::FieldDescriptor *field)

FieldCodecManagerLocal &	manager ()

const FieldCodecManagerLocal &	manager () const

virtual void	set_manager (FieldCodecManagerLocal *manager)

bool	use_required ()
	Whether to use the required or optional encoding.

virtual void	any_encode (Bitset *bits, const dccl::any &wire_value)=0
	Virtual method used to encode.

virtual void	any_decode (Bitset bits, dccl::any wire_value)=0
	Virtual method used to decode.

virtual void	any_pre_encode (dccl::any *wire_value, const dccl::any &field_value)
	Virtual method used to pre-encode (convert from FieldType to WireType). The default implementation of this method is for when WireType == FieldType and simply copies the field_value to the wire_value.

virtual void	any_post_decode (const dccl::any &wire_value, dccl::any *field_value)
	Virtual method used to post-decode (convert from WireType to FieldType). The default implementation of this method is for when WireType == FieldType and simply copies the wire_value to the field_value.

virtual unsigned	any_size (const dccl::any &wire_value)=0
	Virtual method for calculating the size of a field (in bits).

virtual void	validate ()
	Validate a field. Use require() inside your overloaded validate() to assert requirements or throw Exceptions directly as needed.

virtual std::string	info ()
	Write field specific information (in addition to general information such as sizes that are automatically written by this class for all fields.

virtual std::size_t	hash ()
	Generate a field specific hash to be combined with the descriptor hash.

virtual unsigned	max_size ()=0
	Calculate maximum size of the field in bits.

virtual unsigned	min_size ()=0
	Calculate minimum size of the field in bits.

virtual void	any_encode_repeated (Bitset *bits, const std::vector< dccl::any > &wire_values)

virtual void	any_decode_repeated (Bitset repeated_bits, std::vector< dccl::any > field_values)

virtual void	any_pre_encode_repeated (std::vector< dccl::any > *wire_values, const std::vector< dccl::any > &field_values)

virtual void	any_post_decode_repeated (const std::vector< dccl::any > &wire_values, std::vector< dccl::any > *field_values)

virtual unsigned	any_size_repeated (const std::vector< dccl::any > &wire_values)

virtual unsigned	max_size_repeated ()

virtual unsigned	min_size_repeated ()

void	check_repeat_settings () const

Information Methods
std::string	name () const
	the name of the codec used to identifier it in the .proto custom option extension

google::protobuf::FieldDescriptor::Type	field_type () const
	the type exposed to the user in the original and decoded Protobuf messages

google::protobuf::FieldDescriptor::CppType	wire_type () const
	the C++ type used "on the wire". This is the type visible after pre_encode and before post_decode functions are called.

const google::protobuf::FieldDescriptor *	this_field () const
	Returns the FieldDescriptor (field schema meta-data) for this field.

const google::protobuf::Descriptor *	this_descriptor () const
	Returns the Descriptor (message schema meta-data) for the immediate parent Message.

const google::protobuf::Message *	this_message ()

const google::protobuf::Message *	root_message ()

const google::protobuf::Descriptor *	root_descriptor () const

const Bitset *	root_bitset () const
	Returns the root Bitset for the current encode or decode operation.

internal::MessageStackData &	message_data ()

const internal::MessageStackData &	message_data () const

bool	has_codec_group ()

std::string	codec_group ()

int	codec_version ()

MessagePart	part ()
	the part of the message currently being encoded (head or body)

bool	strict ()

void	set_force_use_required (bool force_required=true)
	Force the codec to always use the "required" field encoding, regardless of the FieldDescriptor setting. Useful when wrapping this codec in another that handles optional and repeated fields.

static std::string	codec_group (const google::protobuf::Descriptor *desc)

Detailed Description

Provides a base class for defining DCCL field encoders / decoders. Most users who wish to define custom encoders/decoders will use the RepeatedTypedFieldCodec, TypedFieldCodec or its children (e.g. TypedFixedFieldCodec) instead of directly inheriting from this class.

Definition at line 52 of file field_codec.h.

Member Function Documentation

◆ any_decode()

virtual void dccl::FieldCodecBase::any_decode	(	Bitset *	bits,
		dccl::any *	wire_value
	)

protectedpure virtual

Virtual method used to decode.

Parameters

bits	Bitset containing bits to decode. This will initially contain min_size() bits. If you need more bits, call get_more_bits() with the number of bits required. This bits will be consumed from the bit pool and placed in `bits`.
wire_value	Place to store decoded value (as FieldType)

◆ any_decode_repeated()

void dccl::FieldCodecBase::any_decode_repeated	(	Bitset *	repeated_bits,
		std::vector< dccl::any > *	field_values
	)

protectedvirtual

Definition at line 518 of file field_codec.cpp.

◆ any_encode()

virtual void dccl::FieldCodecBase::any_encode	(	Bitset *	bits,
		const dccl::any &	wire_value
	)

protectedpure virtual

Virtual method used to encode.

Parameters

bits	Bitset to store encoded bits. Bits is just the bits from the current operation (unlike base_encode() and field_encode() where bits are added to the most significant end).
wire_value	Value to encode (WireType)

◆ any_encode_repeated()

void dccl::FieldCodecBase::any_encode_repeated	(	dccl::Bitset *	bits,
		const std::vector< dccl::any > &	wire_values
	)

protectedvirtual

Definition at line 458 of file field_codec.cpp.

◆ any_post_decode()

virtual void dccl::FieldCodecBase::any_post_decode	(	const dccl::any &	wire_value,
		dccl::any *	field_value
	)

inlineprotectedvirtual

Virtual method used to post-decode (convert from WireType to FieldType). The default implementation of this method is for when WireType == FieldType and simply copies the wire_value to the field_value.

Parameters

wire_value	Value to convert (WireType)
field_value	Converted value (FieldType)

Definition at line 445 of file field_codec.h.

◆ any_post_decode_repeated()

void dccl::FieldCodecBase::any_post_decode_repeated	(	const std::vector< dccl::any > &	wire_values,
		std::vector< dccl::any > *	field_values
	)

protectedvirtual

Definition at line 638 of file field_codec.cpp.

◆ any_pre_encode()

virtual void dccl::FieldCodecBase::any_pre_encode	(	dccl::any *	wire_value,
		const dccl::any &	field_value
	)

inlineprotectedvirtual

Virtual method used to pre-encode (convert from FieldType to WireType). The default implementation of this method is for when WireType == FieldType and simply copies the field_value to the wire_value.

Parameters

wire_value	Converted value (WireType)
field_value	Value to convert (FieldType)

Definition at line 436 of file field_codec.h.

◆ any_pre_encode_repeated()

void dccl::FieldCodecBase::any_pre_encode_repeated	(	std::vector< dccl::any > *	wire_values,
		const std::vector< dccl::any > &	field_values
	)

protectedvirtual

Definition at line 628 of file field_codec.cpp.

◆ any_size()

virtual unsigned dccl::FieldCodecBase::any_size ( const dccl::any & wire_value )

protectedpure virtual

Virtual method for calculating the size of a field (in bits).

Parameters

wire_value Value to calculate size of

Returns: Size of field (in bits)

◆ any_size_repeated()

unsigned dccl::FieldCodecBase::any_size_repeated ( const std::vector< dccl::any > & wire_values )

protectedvirtual

Definition at line 553 of file field_codec.cpp.

◆ base_decode()

void dccl::FieldCodecBase::base_decode	(	Bitset *	bits,
		google::protobuf::Message *	msg,
		MessagePart	part
	)

Decode part of a message.

Parameters

bits	Pointer to a Bitset containing bits to decode. The least significant bits will be consumed first. Any bits not consumed will remain in `bits` after this method returns.
msg	DCCL Message to merge the decoded result into.
part	part of the Message to decode

Definition at line 127 of file field_codec.cpp.

◆ base_encode()

void dccl::FieldCodecBase::base_encode	(	Bitset *	bits,
		const google::protobuf::Message &	msg,
		MessagePart	part,
		bool	strict
	)

Encode this part (body or head) of the base message.

Parameters

bits	pointer to a Bitset where all bits will be pushed on to the most significant end.
msg	DCCL Message to encode
part	Part of the message to encode

Definition at line 35 of file field_codec.cpp.

◆ base_hash()

void dccl::FieldCodecBase::base_hash	(	std::size_t *	hash,
		const google::protobuf::Descriptor *	desc,
		MessagePart	part
	)

Provide a hash of the DCCL message definition to detect changes in the DCCL message.

Parameters

hash	Hash value of this message part
desc	Descriptor to validate. Use google::protobuf::Message::GetDescriptor() or MyProtobufType::descriptor() to get this object.
part	part of the Message

Definition at line 387 of file field_codec.cpp.

◆ base_info()

void dccl::FieldCodecBase::base_info	(	std::ostream *	os,
		const google::protobuf::Descriptor *	desc,
		MessagePart	part
	)

Get human readable information (size of fields, etc.) about this part of the DCCL message.

Parameters

os	Pointer to stream to store this information
desc	Descriptor to get information on. Use google::protobuf::Message::GetDescriptor() or MyProtobufType::descriptor() to get this object.
part	the part of the Message to act on.

Definition at line 307 of file field_codec.cpp.

◆ base_max_size()

void dccl::FieldCodecBase::base_max_size	(	unsigned *	bit_size,
		const google::protobuf::Descriptor *	desc,
		MessagePart	part
	)

Calculate the maximum size of a message given its Descriptor alone (no data)

Parameters

bit_size	Pointer to unsigned integer to store calculated maximum size in bits.
desc	Descriptor to calculate the maximum size of. Use google::protobuf::Message::GetDescriptor() or MyProtobufType::descriptor() to get this object.
part	part of the Message

Definition at line 223 of file field_codec.cpp.

◆ base_min_size()

void dccl::FieldCodecBase::base_min_size	(	unsigned *	bit_size,
		const google::protobuf::Descriptor *	desc,
		MessagePart	part
	)

Calculate the minimum size of a message given its Descriptor alone (no data)

Parameters

bit_size	Pointer to unsigned integer to store calculated minimum size in bits.
desc	Descriptor to calculate the minimum size of. Use google::protobuf::Message::GetDescriptor() or MyProtobufType::descriptor() to get this object.
part	part of the Message

Definition at line 249 of file field_codec.cpp.

◆ base_size()

void dccl::FieldCodecBase::base_size	(	unsigned *	bit_size,
		const google::protobuf::Message &	msg,
		MessagePart	part
	)

Calculate the size (in bits) of a part of the base message when it is encoded.

Parameters

bit_size	Pointer to unsigned integer to store the result.
msg	the DCCL Message of which to calculate the size
part	part of the Message to calculate the size of

Definition at line 94 of file field_codec.cpp.

◆ base_validate()

void dccl::FieldCodecBase::base_validate	(	const google::protobuf::Descriptor *	desc,
		MessagePart	part
	)

Validate this part of the message to make sure all required extensions are set.

Parameters

desc	Descriptor to validate. Use google::protobuf::Message::GetDescriptor() or MyProtobufType::descriptor() to get this object.
part	part of the Message

Definition at line 277 of file field_codec.cpp.

◆ check_repeat_settings()

void dccl::FieldCodecBase::check_repeat_settings ( ) const

protected

Definition at line 587 of file field_codec.cpp.

◆ codec_group() [1/2]

std::string dccl::FieldCodecBase::codec_group ( )

Definition at line 749 of file field_codec.cpp.

◆ codec_group() [2/2]

std::string dccl::FieldCodecBase::codec_group ( const google::protobuf::Descriptor * desc )

static

Definition at line 444 of file field_codec.cpp.

◆ codec_version()

int dccl::FieldCodecBase::codec_version ( )

Definition at line 744 of file field_codec.cpp.

◆ dccl_field_options()

dccl::DCCLFieldOptions dccl::FieldCodecBase::dccl_field_options ( ) const

inline

Get the DCCL field option extension value for the current field.

dccl::DCCLFieldOptions is defined in acomms_option_extensions.proto

Definition at line 340 of file field_codec.h.

◆ dynamic_conditions()

dccl::DynamicConditions & dccl::FieldCodecBase::dynamic_conditions ( const google::protobuf::FieldDescriptor * field )

Definition at line 752 of file field_codec.cpp.

◆ field_decode()

void dccl::FieldCodecBase::field_decode	(	Bitset *	bits,
		dccl::any *	field_value,
		const google::protobuf::FieldDescriptor *	field
	)

Decode a non-repeated field.

Parameters

bits	Bits to decode. Used bits are consumed (erased) from the least significant end
field_value	Location to store decoded value (FieldType)
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 140 of file field_codec.cpp.

◆ field_decode_repeated()

void dccl::FieldCodecBase::field_decode_repeated	(	Bitset *	bits,
		std::vector< dccl::any > *	field_values,
		const google::protobuf::FieldDescriptor *	field
	)

Decode a repeated field.

Parameters

bits	Bits to decode. Used bits are consumed (erased) from the least significant end
field_values	Location to store decoded values (FieldType)
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 193 of file field_codec.cpp.

◆ field_encode()

void dccl::FieldCodecBase::field_encode	(	Bitset *	bits,
		const dccl::any &	field_value,
		const google::protobuf::FieldDescriptor *	field
	)

Encode a non-repeated field.

Parameters

bits	Pointer to bitset to store encoded bits. Bits are added to the most significant end of `bits`
field_value	Value to encode (FieldType)
field	Protobuf descriptor to the field to encode. Set to 0 for base message.

Definition at line 48 of file field_codec.cpp.

◆ field_encode_repeated()

void dccl::FieldCodecBase::field_encode_repeated	(	Bitset *	bits,
		const std::vector< dccl::any > &	field_values,
		const google::protobuf::FieldDescriptor *	field
	)

Encode a repeated field.

Parameters

bits	Pointer to bitset to store encoded bits. Bits are added to the most significant end of `bits`
field_values	Values to encode (FieldType)
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 79 of file field_codec.cpp.

◆ field_hash()

void dccl::FieldCodecBase::field_hash	(	std::size_t *	hash,
		const google::protobuf::FieldDescriptor *	field
	)

Provide a hash for this field definition.

Parameters

hash	Hash value of this field
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 401 of file field_codec.cpp.

◆ field_info()

void dccl::FieldCodecBase::field_info	(	std::ostream *	os,
		const google::protobuf::FieldDescriptor *	field
	)

Write human readable information about the field and its bounds to the provided stream.

Parameters

os	Stream to write info to.
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 321 of file field_codec.cpp.

◆ field_max_size()

void dccl::FieldCodecBase::field_max_size	(	unsigned *	bit_size,
		const google::protobuf::FieldDescriptor *	field
	)

Calculate the upper bound on this field's size (in bits)

Parameters

bit_size	Location to add calculated maximum bit size to. Be sure to zero `bit_size` if you want only the size of this field.
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 238 of file field_codec.cpp.

◆ field_min_size()

void dccl::FieldCodecBase::field_min_size	(	unsigned *	bit_size,
		const google::protobuf::FieldDescriptor *	field
	)

Calculate the lower bound on this field's size (in bits)

Parameters

bit_size	Location to add calculated minimum bit size to. Be sure to zero `bit_size` if you want only the size of this field.
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 265 of file field_codec.cpp.

◆ field_post_decode()

void dccl::FieldCodecBase::field_post_decode	(	const dccl::any &	wire_value,
		dccl::any *	field_value
	)

inline

Post-decodes a non-repeated (i.e. optional or required) field by converting the WireType (the type used in the encoded DCCL message) representation into the FieldType representation (the Google Protobuf representation). This allows for type-converting codecs.

Parameters

wire_value	Should be set to the desired value to translate
field_value	Will be set to the converted wire_value

Definition at line 289 of file field_codec.h.

◆ field_post_decode_repeated()

void dccl::FieldCodecBase::field_post_decode_repeated	(	const std::vector< dccl::any > &	wire_values,
		std::vector< dccl::any > *	field_values
	)

inline

Post-decodes a repeated field.

Parameters

wire_values	Should be set to the desired values to translate
field_values	Will be set to the converted wire_values

Definition at line 298 of file field_codec.h.

◆ field_pre_encode()

void dccl::FieldCodecBase::field_pre_encode	(	dccl::any *	wire_value,
		const dccl::any &	field_value
	)

inline

Pre-encodes a non-repeated (i.e. optional or required) field by converting the FieldType representation (the Google Protobuf representation) into the WireType representation (the type used in the encoded DCCL message). This allows for type-converting codecs.

These are called typically by DefaultMessageCodec to start processing a new field. In this example "bar" and "baz" are fields:

message Foo
{
   int32 bar = 1;
   FooBar baz = 2;
}

Parameters

wire_value	Will be set to the converted field_value
field_value	Value to convert to the appropriate wire_value

Definition at line 219 of file field_codec.h.

◆ field_pre_encode_repeated()

void dccl::FieldCodecBase::field_pre_encode_repeated	(	std::vector< dccl::any > *	wire_values,
		const std::vector< dccl::any > &	field_values
	)

inline

Pre-encodes a repeated field.

Parameters

wire_values	Should be set to the converted field_values
field_values	Values to convert to the appropriate wire_values

Definition at line 228 of file field_codec.h.

◆ field_size()

void dccl::FieldCodecBase::field_size	(	unsigned *	bit_size,
		const dccl::any &	field_value,
		const google::protobuf::FieldDescriptor *	field
	)

Calculate the size of a field.

Parameters

bit_size	Location to add calculated bit size to. Be sure to zero `bit_size` if you want only the size of this field.
field_value	Value calculate size of (FieldType)
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 104 of file field_codec.cpp.

◆ field_size_repeated()

void dccl::FieldCodecBase::field_size_repeated	(	unsigned *	bit_size,
		const std::vector< dccl::any > &	field_values,
		const google::protobuf::FieldDescriptor *	field
	)

Calculate the size of a repeated field.

Parameters

bit_size	Location to add calculated bit size to. Be sure to zero `bit_size` if you want only the size of this field.
field_values	Values to calculate size of (FieldType)
field	Protobuf descriptor to the field. Set to 0 for base message.

Definition at line 115 of file field_codec.cpp.

◆ field_type()

google::protobuf::FieldDescriptor::Type dccl::FieldCodecBase::field_type ( ) const

inline

the type exposed to the user in the original and decoded Protobuf messages

Returns: the Google Protobuf message type. See http://code.google.com/apis/protocolbuffers/docs/reference/cpp/google.protobuf.descriptor.html#FieldDescriptor.Type.details

Definition at line 69 of file field_codec.h.

◆ field_validate()

void dccl::FieldCodecBase::field_validate	(	bool *	b,
		const google::protobuf::FieldDescriptor *	field
	)

Validate this field, checking that all required option extensions are set (e.g. (dccl.field).max and (dccl.field).min for arithmetic codecs)

Parameters

b	Currently unused (will be set to false)
field	Protobuf descriptor to the field. Set to 0 for base message.

Exceptions

Exception If field is invalid

Definition at line 291 of file field_codec.cpp.

◆ has_codec_group()

bool dccl::FieldCodecBase::has_codec_group ( )

Definition at line 728 of file field_codec.cpp.

◆ hash()

virtual std::size_t dccl::FieldCodecBase::hash ( )

inlineprotectedvirtual

Generate a field specific hash to be combined with the descriptor hash.

Reimplemented in dccl::v3::DefaultEnumCodec.

Definition at line 466 of file field_codec.h.

◆ info()

std::string dccl::FieldCodecBase::info ( )

protectedvirtual

Write field specific information (in addition to general information such as sizes that are automatically written by this class for all fields.

Returns: string containing information to display.

Definition at line 456 of file field_codec.cpp.

◆ manager() [1/2]

FieldCodecManagerLocal & dccl::FieldCodecBase::manager ( )

inline

Definition at line 371 of file field_codec.h.

◆ manager() [2/2]

const FieldCodecManagerLocal & dccl::FieldCodecBase::manager ( ) const

inline

Definition at line 379 of file field_codec.h.

◆ max_size()

virtual unsigned dccl::FieldCodecBase::max_size ( )

protectedpure virtual

Calculate maximum size of the field in bits.

Returns: Maximum size of this field (in bits).

◆ max_size_repeated()

unsigned dccl::FieldCodecBase::max_size_repeated ( )

protectedvirtual

Reimplemented in dccl::arith::ArithmeticFieldCodecBase< const google::protobuf::EnumValueDescriptor * >, dccl::arith::ArithmeticFieldCodecBase< FieldType >, dccl::arith::ArithmeticFieldCodecBase< FieldType >, dccl::RepeatedTypedFieldCodec< WireType, FieldType >, dccl::RepeatedTypedFieldCodec< dccl::int32 >, dccl::RepeatedTypedFieldCodec< Model::value_type, const google::protobuf::EnumValueDescriptor * >, dccl::RepeatedTypedFieldCodec< Model::value_type, FieldType >, and dccl::RepeatedTypedFieldCodec< Model::value_type, Model::value_type >.

Definition at line 603 of file field_codec.cpp.

◆ message_data() [1/2]

dccl::internal::MessageStackData & dccl::FieldCodecBase::message_data ( )

Definition at line 719 of file field_codec.cpp.

◆ message_data() [2/2]

const dccl::internal::MessageStackData & dccl::FieldCodecBase::message_data ( ) const

Definition at line 724 of file field_codec.cpp.

◆ min_size()

virtual unsigned dccl::FieldCodecBase::min_size ( )

protectedpure virtual

Calculate minimum size of the field in bits.

Returns: Minimum size of this field (in bits).

◆ min_size_repeated()

unsigned dccl::FieldCodecBase::min_size_repeated ( )

protectedvirtual

Reimplemented in dccl::arith::ArithmeticFieldCodecBase< const google::protobuf::EnumValueDescriptor * >, dccl::arith::ArithmeticFieldCodecBase< FieldType >, dccl::arith::ArithmeticFieldCodecBase< FieldType >, dccl::RepeatedTypedFieldCodec< WireType, FieldType >, dccl::RepeatedTypedFieldCodec< dccl::int32 >, dccl::RepeatedTypedFieldCodec< Model::value_type, const google::protobuf::EnumValueDescriptor * >, dccl::RepeatedTypedFieldCodec< Model::value_type, FieldType >, and dccl::RepeatedTypedFieldCodec< Model::value_type, Model::value_type >.

Definition at line 615 of file field_codec.cpp.

◆ name()

std::string dccl::FieldCodecBase::name ( ) const

inline

the name of the codec used to identifier it in the .proto custom option extension

Definition at line 65 of file field_codec.h.

◆ part()

dccl::MessagePart dccl::FieldCodecBase::part ( )

the part of the message currently being encoded (head or body)

Definition at line 740 of file field_codec.cpp.

◆ require()

void dccl::FieldCodecBase::require	(	bool	b,
		const std::string &	description
	)

inline

Essentially an assertion to be used in the validate() virtual method.

Parameters

b	Boolean to assert (if true, execution continues, if false an exception is thrown)
description	Debugging description for this assertion (will be appended to the exception)

Exceptions

Exception Thrown if !b

Definition at line 354 of file field_codec.h.

◆ root_bitset()

const dccl::Bitset * dccl::FieldCodecBase::root_bitset ( ) const

Returns the root Bitset for the current encode or decode operation.

During encoding: points to the Bitset accumulating all body bits so far (before this field). During decoding: points to a copy of the full Bitset taken at the start of base_decode(). Returns nullptr if called outside of an encode/decode context.

Definition at line 714 of file field_codec.cpp.

◆ root_descriptor()

const google::protobuf::Descriptor * dccl::FieldCodecBase::root_descriptor ( ) const

Definition at line 709 of file field_codec.cpp.

◆ root_message()

const google::protobuf::Message * dccl::FieldCodecBase::root_message ( )

Definition at line 704 of file field_codec.cpp.

◆ set_force_use_required()

void dccl::FieldCodecBase::set_force_use_required ( bool force_required = true )

inline

Force the codec to always use the "required" field encoding, regardless of the FieldDescriptor setting. Useful when wrapping this codec in another that handles optional and repeated fields.

Definition at line 128 of file field_codec.h.

◆ set_manager()

virtual void dccl::FieldCodecBase::set_manager ( FieldCodecManagerLocal * manager )

inlinevirtual

Definition at line 387 of file field_codec.h.

◆ strict()

bool dccl::FieldCodecBase::strict ( )

Definition at line 742 of file field_codec.cpp.

◆ this_descriptor()

const google::protobuf::Descriptor * dccl::FieldCodecBase::this_descriptor ( ) const

Returns the Descriptor (message schema meta-data) for the immediate parent Message.

for:

message Foo
{
   int32 bar = 1;
   FooBar baz = 2;
}

returns Descriptor for Foo if this_field() == 0 returns Descriptor for Foo if this_field() == FieldDescriptor for bar returns Descriptor for FooBar if this_field() == FieldDescriptor for baz

Definition at line 694 of file field_codec.cpp.

◆ this_field()

const google::protobuf::FieldDescriptor * dccl::FieldCodecBase::this_field ( ) const

Returns the FieldDescriptor (field schema meta-data) for this field.

Returns: FieldDescriptor for the current field or 0 if this codec is encoding the base message.

Definition at line 689 of file field_codec.cpp.

◆ this_message()

const google::protobuf::Message * dccl::FieldCodecBase::this_message ( )

Definition at line 699 of file field_codec.cpp.

◆ use_required()

bool dccl::FieldCodecBase::use_required ( )

inlineprotected

Whether to use the required or optional encoding.

Definition at line 391 of file field_codec.h.

◆ validate()

virtual void dccl::FieldCodecBase::validate ( )

inlineprotectedvirtual

Validate a field. Use require() inside your overloaded validate() to assert requirements or throw Exceptions directly as needed.

Definition at line 458 of file field_codec.h.

◆ wire_type()

google::protobuf::FieldDescriptor::CppType dccl::FieldCodecBase::wire_type ( ) const

inline

the C++ type used "on the wire". This is the type visible after pre_encode and before post_decode functions are called.

The wire type allows codecs to make type changes (e.g. from string to integer) before reusing another codec that knows how to encode that wire type (e.g. DefaultNumericFieldCodec)

Returns: the C++ type used to encode and decode. See http://code.google.com/apis/protocolbuffers/docs/reference/cpp/google.protobuf.descriptor.html#FieldDescriptor.CppType.details

Definition at line 74 of file field_codec.h.

Friends And Related Symbol Documentation

◆ BaseRAII

friend struct BaseRAII

friend

Definition at line 531 of file field_codec.h.

◆ FieldCodecManagerLocal

friend class FieldCodecManagerLocal

friend

Definition at line 492 of file field_codec.h.

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

dccl/field_codec.h
src/field_codec.cpp

Public Member Functions

Field functions (primitive types and embedded messages)

Information Methods

Detailed Description

Member Function Documentation

◆ any_decode()

◆ any_decode_repeated()

◆ any_encode()

◆ any_encode_repeated()

◆ any_post_decode()

◆ any_post_decode_repeated()

◆ any_pre_encode()

◆ any_pre_encode_repeated()

◆ any_size()

◆ any_size_repeated()

◆ base_decode()

◆ base_encode()

◆ base_hash()

◆ base_info()

◆ base_max_size()

◆ base_min_size()

◆ base_size()

◆ base_validate()

◆ check_repeat_settings()

◆ codec_group() [1/2]

◆ codec_group() [2/2]

◆ codec_version()

◆ dccl_field_options()

◆ dynamic_conditions()

◆ field_decode()

◆ field_decode_repeated()

◆ field_encode()

◆ field_encode_repeated()

◆ field_hash()

◆ field_info()

◆ field_max_size()

◆ field_min_size()

◆ field_post_decode()

◆ field_post_decode_repeated()

◆ field_pre_encode()

◆ field_pre_encode_repeated()

◆ field_size()

◆ field_size_repeated()

◆ field_type()

◆ field_validate()

◆ has_codec_group()

◆ hash()

◆ info()

◆ manager() [1/2]

◆ manager() [2/2]

◆ max_size()

◆ max_size_repeated()

◆ message_data() [1/2]

◆ message_data() [2/2]

◆ min_size()

◆ min_size_repeated()

◆ name()

◆ part()

◆ require()

◆ root_bitset()

◆ root_descriptor()

◆ root_message()

◆ set_force_use_required()

◆ set_manager()

◆ strict()

◆ this_descriptor()

◆ this_field()

◆ this_message()

◆ use_required()

◆ validate()

◆ wire_type()

Friends And Related Symbol Documentation

◆ BaseRAII

◆ FieldCodecManagerLocal