LabelingOptions Class Reference

Interface for configuring labeling options for the SetLabel/DeleteLabel methods. More...

#include <src/api/mip/file/labeling_options.h>

Collaboration diagram for LabelingOptions:

Public Member Functions
AssignmentMethod	GetAssignmentMethod () const
const std::vector< std::pair< std::string, std::string > > &	GetExtendedProperties () const
const std::string &	GetJustificationMessage () const
bool	IsDowngradeJustified () const
	LabelingOptions (AssignmentMethod method)
void	SetDowngradeJustification (bool isDowngradeJustified, const std::string &justificationMessage)
void	SetExtendedProperties (const std::vector< std::pair< std::string, std::string > > &extendedProperties)

Private Attributes
AssignmentMethod	mAssignmentMethod
std::vector< std::pair< std::string, std::string > >	mExtendedProperties
bool	mIsDowngradeJustified
std::string	mJustificationMessage

Detailed Description

Interface for configuring labeling options for the SetLabel/DeleteLabel methods.

Definition at line 42 of file labeling_options.h.

Constructor & Destructor Documentation

LabelingOptions()

LabelingOptions::LabelingOptions ( AssignmentMethod method )

inline

Definition at line 45 of file labeling_options.h.

    : mAssignmentMethod(method),
      mIsDowngradeJustified(false) {
  }

Member Function Documentation

GetAssignmentMethod()

AssignmentMethod LabelingOptions::GetAssignmentMethod ( ) const

inline

Definition at line 50 of file labeling_options.h.

                                               {
    return mAssignmentMethod;
  }

References mAssignmentMethod.

GetExtendedProperties()

const std::vector< std::pair< std::string, std::string > > & LabelingOptions::GetExtendedProperties ( ) const

inline

Definition at line 62 of file labeling_options.h.

                                                                                {
    return mExtendedProperties;
  }

References mExtendedProperties.

GetJustificationMessage()

const std::string & LabelingOptions::GetJustificationMessage ( ) const

inline

Definition at line 58 of file labeling_options.h.

                                                   {
    return mJustificationMessage;
  }

References mJustificationMessage.

IsDowngradeJustified()

bool LabelingOptions::IsDowngradeJustified ( ) const

inline

Definition at line 54 of file labeling_options.h.

                                    {
    return mIsDowngradeJustified;
  }

References mIsDowngradeJustified.

SetDowngradeJustification()

void LabelingOptions::SetDowngradeJustification ( bool isDowngradeJustified, const std::string & justificationMessage )

inline

Definition at line 66 of file labeling_options.h.

                                                                                                   {
    mIsDowngradeJustified = isDowngradeJustified;
    mJustificationMessage = justificationMessage;
  }

References mIsDowngradeJustified, and mJustificationMessage.

SetExtendedProperties()

void LabelingOptions::SetExtendedProperties ( const std::vector< std::pair< std::string, std::string > > & extendedProperties )

inline

Definition at line 71 of file labeling_options.h.

                                                                                                 {
    mExtendedProperties = extendedProperties;
  }

References mExtendedProperties.

Member Data Documentation

mAssignmentMethod

AssignmentMethod LabelingOptions::mAssignmentMethod

private

Definition at line 76 of file labeling_options.h.

Referenced by GetAssignmentMethod().

mExtendedProperties

std::vector<std::pair<std::string, std::string> > LabelingOptions::mExtendedProperties

private

Definition at line 79 of file labeling_options.h.

Referenced by GetExtendedProperties(), and SetExtendedProperties().

mIsDowngradeJustified

bool LabelingOptions::mIsDowngradeJustified

private

Definition at line 77 of file labeling_options.h.

Referenced by IsDowngradeJustified(), and SetDowngradeJustification().

mJustificationMessage

std::string LabelingOptions::mJustificationMessage

private

Definition at line 78 of file labeling_options.h.

Referenced by GetJustificationMessage(), and SetDowngradeJustification().

---

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

• src/api/mip/file/labeling_options.h