Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
com.google.ortools.linearsolver.MPModelProto.Annotation Class Reference
Inheritance diagram for com.google.ortools.linearsolver.MPModelProto.Annotation:
com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder

Classes

class  Builder
 
enum  TargetType
 

Public Member Functions

boolean hasTargetType ()
 
com.google.ortools.linearsolver.MPModelProto.Annotation.TargetType getTargetType ()
 
boolean hasTargetIndex ()
 
int getTargetIndex ()
 
boolean hasTargetName ()
 
java.lang.String getTargetName ()
 
com.google.protobuf.ByteString getTargetNameBytes ()
 
boolean hasPayloadKey ()
 
java.lang.String getPayloadKey ()
 
com.google.protobuf.ByteString getPayloadKeyBytes ()
 
boolean hasPayloadValue ()
 
java.lang.String getPayloadValue ()
 
com.google.protobuf.ByteString getPayloadValueBytes ()
 
final boolean isInitialized ()
 
void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
 
int getSerializedSize ()
 
boolean equals (final java.lang.Object obj)
 
int hashCode ()
 
Builder newBuilderForType ()
 
Builder toBuilder ()
 
com.google.protobuf.Parser< Annotation > getParserForType ()
 
com.google.ortools.linearsolver.MPModelProto.Annotation getDefaultInstanceForType ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPModelProto.Annotation parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static Builder newBuilder ()
 
static Builder newBuilder (com.google.ortools.linearsolver.MPModelProto.Annotation prototype)
 
static com.google.ortools.linearsolver.MPModelProto.Annotation getDefaultInstance ()
 
static com.google.protobuf.Parser< Annotation > parser ()
 

Static Public Attributes

static final int TARGET_TYPE_FIELD_NUMBER = 1
 
static final int TARGET_INDEX_FIELD_NUMBER = 2
 
static final int TARGET_NAME_FIELD_NUMBER = 3
 
static final int PAYLOAD_KEY_FIELD_NUMBER = 4
 
static final int PAYLOAD_VALUE_FIELD_NUMBER = 5
 

Protected Member Functions

com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable ()
 
Builder newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)
 

Detailed Description

Annotations can be freely added by users who want to attach arbitrary
payload to the model's variables or constraints.

Protobuf type operations_research.MPModelProto.Annotation

Definition at line 176 of file MPModelProto.java.

Member Function Documentation

◆ equals()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.equals ( final java.lang.Object obj)

Definition at line 616 of file MPModelProto.java.

◆ getDefaultInstance()

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.getDefaultInstance ( )
static

Definition at line 1391 of file MPModelProto.java.

◆ getDefaultInstanceForType()

com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.getDefaultInstanceForType ( )

Definition at line 1427 of file MPModelProto.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.linearsolver.MPModelProto.Annotation.getDescriptor ( )
static

Definition at line 202 of file MPModelProto.java.

◆ getParserForType()

com.google.protobuf.Parser< Annotation > com.google.ortools.linearsolver.MPModelProto.Annotation.getParserForType ( )

Definition at line 1422 of file MPModelProto.java.

◆ getPayloadKey()

java.lang.String com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadKey ( ) 
The payload is a (key, value) string pair. Depending on the use cases,
one of the two may be omitted.

optional string payload_key = 4;

Returns
The payloadKey.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 468 of file MPModelProto.java.

◆ getPayloadKeyBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadKeyBytes ( ) 
The payload is a (key, value) string pair. Depending on the use cases,
one of the two may be omitted.

optional string payload_key = 4;

Returns
The bytes for payloadKey.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 493 of file MPModelProto.java.

◆ getPayloadValue()

java.lang.String com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadValue ( )

optional string payload_value = 5;

Returns
The payloadValue.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 522 of file MPModelProto.java.

◆ getPayloadValueBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadValueBytes ( )

optional string payload_value = 5;

Returns
The bytes for payloadValue.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 542 of file MPModelProto.java.

◆ getSerializedSize()

int com.google.ortools.linearsolver.MPModelProto.Annotation.getSerializedSize ( )

Definition at line 588 of file MPModelProto.java.

◆ getTargetIndex()

int com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetIndex ( ) 
If both `target_index` and `target_name` are set, they must point to the
same entity.

optional int32 target_index = 2;

Returns
The targetIndex.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 377 of file MPModelProto.java.

◆ getTargetName()

java.lang.String com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetName ( ) 
Alternate to index. Assumes uniqueness.

optional string target_name = 3;

Returns
The targetName.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 405 of file MPModelProto.java.

◆ getTargetNameBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetNameBytes ( ) 
Alternate to index. Assumes uniqueness.

optional string target_name = 3;

Returns
The bytes for targetName.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 429 of file MPModelProto.java.

◆ getTargetType()

com.google.ortools.linearsolver.MPModelProto.Annotation.TargetType com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetType ( )

optional .operations_research.MPModelProto.Annotation.TargetType target_type = 1;

Returns
The targetType.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 347 of file MPModelProto.java.

◆ hashCode()

int com.google.ortools.linearsolver.MPModelProto.Annotation.hashCode ( )

Definition at line 654 of file MPModelProto.java.

◆ hasPayloadKey()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasPayloadKey ( ) 
The payload is a (key, value) string pair. Depending on the use cases,
one of the two may be omitted.

optional string payload_key = 4;

Returns
Whether the payloadKey field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 455 of file MPModelProto.java.

◆ hasPayloadValue()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasPayloadValue ( )

optional string payload_value = 5;

Returns
Whether the payloadValue field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 514 of file MPModelProto.java.

◆ hasTargetIndex()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasTargetIndex ( ) 
If both `target_index` and `target_name` are set, they must point to the
same entity.

optional int32 target_index = 2;

Returns
Whether the targetIndex field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 364 of file MPModelProto.java.

◆ hasTargetName()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasTargetName ( ) 
Alternate to index. Assumes uniqueness.

optional string target_name = 3;

Returns
Whether the targetName field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 393 of file MPModelProto.java.

◆ hasTargetType()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasTargetType ( )

optional .operations_research.MPModelProto.Annotation.TargetType target_type = 1;

Returns
Whether the targetType field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 340 of file MPModelProto.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.linearsolver.MPModelProto.Annotation.internalGetFieldAccessorTable ( )
protected

Definition at line 208 of file MPModelProto.java.

◆ isInitialized()

final boolean com.google.ortools.linearsolver.MPModelProto.Annotation.isInitialized ( )

Definition at line 557 of file MPModelProto.java.

◆ newBuilder() [1/2]

static Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilder ( )
static

Definition at line 759 of file MPModelProto.java.

◆ newBuilder() [2/2]

static Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilder ( com.google.ortools.linearsolver.MPModelProto.Annotation prototype)
static

Definition at line 762 of file MPModelProto.java.

◆ newBuilderForType() [1/2]

Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilderForType ( )

Definition at line 758 of file MPModelProto.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 772 of file MPModelProto.java.

◆ parseDelimitedFrom() [1/2]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 730 of file MPModelProto.java.

◆ parseDelimitedFrom() [2/2]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseDelimitedFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 736 of file MPModelProto.java.

◆ parseFrom() [1/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 707 of file MPModelProto.java.

◆ parseFrom() [2/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 711 of file MPModelProto.java.

◆ parseFrom() [3/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 696 of file MPModelProto.java.

◆ parseFrom() [4/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 701 of file MPModelProto.java.

◆ parseFrom() [5/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.CodedInputStream input) throws java.io.IOException
static

Definition at line 743 of file MPModelProto.java.

◆ parseFrom() [6/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 749 of file MPModelProto.java.

◆ parseFrom() [7/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 717 of file MPModelProto.java.

◆ parseFrom() [8/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 722 of file MPModelProto.java.

◆ parseFrom() [9/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 685 of file MPModelProto.java.

◆ parseFrom() [10/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 690 of file MPModelProto.java.

◆ parser()

static com.google.protobuf.Parser< Annotation > com.google.ortools.linearsolver.MPModelProto.Annotation.parser ( )
static

Definition at line 1417 of file MPModelProto.java.

◆ toBuilder()

Builder com.google.ortools.linearsolver.MPModelProto.Annotation.toBuilder ( )

Definition at line 766 of file MPModelProto.java.

◆ writeTo()

void com.google.ortools.linearsolver.MPModelProto.Annotation.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 567 of file MPModelProto.java.

Member Data Documentation

◆ PAYLOAD_KEY_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.PAYLOAD_KEY_FIELD_NUMBER = 4
static

Definition at line 442 of file MPModelProto.java.

◆ PAYLOAD_VALUE_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.PAYLOAD_VALUE_FIELD_NUMBER = 5
static

Definition at line 506 of file MPModelProto.java.

◆ TARGET_INDEX_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.TARGET_INDEX_FIELD_NUMBER = 2
static

Definition at line 352 of file MPModelProto.java.

◆ TARGET_NAME_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.TARGET_NAME_FIELD_NUMBER = 3
static

Definition at line 381 of file MPModelProto.java.

◆ TARGET_TYPE_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.TARGET_TYPE_FIELD_NUMBER = 1
static

Definition at line 334 of file MPModelProto.java.

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