Space Engineers
Public Member Functions | Properties | List of all members
ProtoBuf.ProtoMemberAttribute Class Reference

Declares a member to be used in protocol-buffer serialization, using the given Tag. A DataFormat may be used to optimise the serialization format (for instance, using zigzag encoding for negative numbers, or fixed-length encoding for large values. More...

Inheritance diagram for ProtoBuf.ProtoMemberAttribute:
ProtoBuf.ProtoPartialMemberAttribute

Public Member Functions

int CompareTo (object other)
 Compare with another ProtoMemberAttribute for sorting purposes More...
 
int CompareTo (ProtoMemberAttribute other)
 Compare with another ProtoMemberAttribute for sorting purposes More...
 
 ProtoMemberAttribute ([CallerLineNumber]int tag=0)
 Creates a new ProtoMemberAttribute instance. More...
 

Properties

string Name [get, set]
 Gets or sets the original name defined in the .proto; not used during serialization. More...
 
DataFormat DataFormat [get, set]
 Gets or sets the data-format to be used when encoding this value. More...
 
int Tag [get]
 Gets the unique tag used to identify this member within the type. More...
 
bool IsRequired [get, set]
 Gets or sets a value indicating whether this member is mandatory. More...
 
bool IsPacked [get, set]
 Gets a value indicating whether this member is packed. This option only applies to list/array data of primitive types (int, double, etc). More...
 
bool OverwriteList [get, set]
 Indicates whether this field should repace existing values (the default is false, meaning append). This option only applies to list/array data. More...
 
bool AsReference [get, set]
 Enables full object-tracking/full-graph support. More...
 
bool DynamicType [get, set]
 Embeds the type information into the stream, allowing usage with types not known in advance. More...
 
MemberSerializationOptions Options [get, set]
 Gets or sets a value indicating whether this member is packed (lists/arrays). More...
 

Detailed Description

Declares a member to be used in protocol-buffer serialization, using the given Tag. A DataFormat may be used to optimise the serialization format (for instance, using zigzag encoding for negative numbers, or fixed-length encoding for large values.

Definition at line 30 of file ProtoMemberAttribute.cs.

Constructor & Destructor Documentation

ProtoBuf.ProtoMemberAttribute.ProtoMemberAttribute ( [CallerLineNumber] int  tag = 0)
inline

Creates a new ProtoMemberAttribute instance.

Parameters
tagSpecifies the unique tag used to identify this member within the type.

Definition at line 74 of file ProtoMemberAttribute.cs.

Member Function Documentation

int ProtoBuf.ProtoMemberAttribute.CompareTo ( object  other)
inline

Compare with another ProtoMemberAttribute for sorting purposes

Definition at line 42 of file ProtoMemberAttribute.cs.

int ProtoBuf.ProtoMemberAttribute.CompareTo ( ProtoMemberAttribute  other)
inline

Compare with another ProtoMemberAttribute for sorting purposes

Definition at line 46 of file ProtoMemberAttribute.cs.

Property Documentation

bool ProtoBuf.ProtoMemberAttribute.AsReference
getset

Enables full object-tracking/full-graph support.

Definition at line 151 of file ProtoMemberAttribute.cs.

DataFormat ProtoBuf.ProtoMemberAttribute.DataFormat
getset

Gets or sets the data-format to be used when encoding this value.

Definition at line 99 of file ProtoMemberAttribute.cs.

bool ProtoBuf.ProtoMemberAttribute.DynamicType
getset

Embeds the type information into the stream, allowing usage with types not known in advance.

Definition at line 175 of file ProtoMemberAttribute.cs.

bool ProtoBuf.ProtoMemberAttribute.IsPacked
getset

Gets a value indicating whether this member is packed. This option only applies to list/array data of primitive types (int, double, etc).

Definition at line 125 of file ProtoMemberAttribute.cs.

bool ProtoBuf.ProtoMemberAttribute.IsRequired
getset

Gets or sets a value indicating whether this member is mandatory.

Definition at line 112 of file ProtoMemberAttribute.cs.

string ProtoBuf.ProtoMemberAttribute.Name
getset

Gets or sets the original name defined in the .proto; not used during serialization.

Definition at line 93 of file ProtoMemberAttribute.cs.

MemberSerializationOptions ProtoBuf.ProtoMemberAttribute.Options
getset

Gets or sets a value indicating whether this member is packed (lists/arrays).

Definition at line 187 of file ProtoMemberAttribute.cs.

bool ProtoBuf.ProtoMemberAttribute.OverwriteList
getset

Indicates whether this field should repace existing values (the default is false, meaning append). This option only applies to list/array data.

Definition at line 138 of file ProtoMemberAttribute.cs.

int ProtoBuf.ProtoMemberAttribute.Tag
get

Gets the unique tag used to identify this member within the type.

Definition at line 105 of file ProtoMemberAttribute.cs.


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