metadata.h File Reference

Function declarations for metadata.c. More...

#include "scip/scip.h"
#include "parent_set_data.h"
#include "pedigree_data.h"
#include "property_data.h"

Include dependency graph for metadata.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
ParentSetData *	MD_getParentSetData (SCIP *scip)
	Gets the parent set information associated with the problem. More...
PedigreeData *	MD_getPedigreeData (SCIP *scip)
	Gets the pedigree information associated with the problem. More...
PropertyData *	MD_getPropertyData (SCIP *scip)
	Gets the property information associated with the problem. More...
SCIP_RETCODE	MD_initialiseMetadata (SCIP *scip)
	Initialised the metadata, so that information can be stored in it. More...
SCIP_RETCODE	MD_setParentSetData (SCIP *scip, ParentSetData *psd)
	Sets the parent set data associated with the problem. More...
SCIP_RETCODE	MD_setPedigreeData (SCIP *scip, PedigreeData *pd)
	Sets the pedigree data associated with the problem. More...
SCIP_RETCODE	MD_setPropertyData (SCIP *scip, PropertyData *pd)
	Sets the property data associated with the problem. More...

Detailed Description

Function declarations for metadata.c.

Function Documentation

MD_getParentSetData()

ParentSetData* MD_getParentSetData

(

SCIP *

scip

)

Gets the parent set information associated with the problem.

Note that this will return the actual stored data structure, not a copy.

Parameters

scip	The SCIP instance the metadata belongs to.

Returns

The parent set data stored for the problem.

References CONSHDLR_NAME.

Referenced by BN_addMECNonRepetitionConstraint(), BN_addNonRepetitionConstraint(), BN_doIterativePrint(), BN_printcountsols(), BN_printScores(), BN_readProblem(), and SCIP_DECL_HEUREXEC().

MD_getPedigreeData()

PedigreeData* MD_getPedigreeData

(

SCIP *

scip

)

Gets the pedigree information associated with the problem.

Note that this will return the actual stored data structure, not a copy.

Parameters

scip	The SCIP instance the metadata belongs to.

Returns

The pedigree data stored for the problem.

References CONSHDLR_NAME.

Referenced by assignSexVariables(), PD_addPedigreeSpecificConstraints(), PD_getCurrentPedigreeVarValues(), and PD_printSolutionPedigreeFormat().

MD_getPropertyData()

PropertyData* MD_getPropertyData

(

SCIP *

scip

)

Gets the property information associated with the problem.

Note that this will return the actual stored data structure, not a copy.

Parameters

scip	The SCIP instance the metadata belongs to.

Returns

The property data stored for the problem.

References CONSHDLR_NAME.

MD_initialiseMetadata()

SCIP_RETCODE MD_initialiseMetadata

(

SCIP *

scip

)

Initialised the metadata, so that information can be stored in it.

This function must be called before attempting to add data using MD_setParentSetData().

Parameters

scip	The SCIP instance to which the metadata will belong.

Returns

SCIP_OKAY if initialisation succeeded or an appropriate error code otherwise.

References CONSHDLR_NAME.

Referenced by BN_includePlugins().

MD_setParentSetData()

SCIP_RETCODE MD_setParentSetData	(	SCIP *	scip,
		ParentSetData *	psd
	)

Sets the parent set data associated with the problem.

This method should only be called once, when the metadata first becomes available for storage. If the information needs changing at a later date, call MD_getParentSetData() and modify the data structure directly.

Parameters

scip	The SCIP instance the metdata relates to.
psd	The parent set data for the problem

Returns

SCIP_OKAY if storage worked, or an appropriate error message otherwise.

References createBlankConstraint(), getConshdlrDataIfExists(), PARENT_SET_NAME, and PS_copyParentSetData().

Referenced by readProblemInNonCIPFormat().

Here is the call graph for this function:

MD_setPedigreeData()

SCIP_RETCODE MD_setPedigreeData	(	SCIP *	scip,
		PedigreeData *	pd
	)

Sets the pedigree data associated with the problem.

This method should only be called once, when the metadata first becomes available for storage. If the information needs changing at a later date, call MD_getPedigreeData() and modify the data structure directly.

Parameters

scip	The SCIP instance the metdata relates to.
pd	The pedigree data for the problem

Returns

SCIP_OKAY if storage worked, or an appropriate error message otherwise.

References createBlankConstraint(), getConshdlrDataIfExists(), PE_copyPedigreeData(), and PEDIGREE_NAME.

Referenced by PD_addPedigreeSpecificConstraints().

Here is the call graph for this function:

MD_setPropertyData()

SCIP_RETCODE MD_setPropertyData	(	SCIP *	scip,
		PropertyData *	prop
	)

Sets the property data associated with the problem.

This method should only be called once, when the metadata first becomes available for storage. If the information needs changing at a later date, call MD_getPropertyData() and modify the data structure directly.

Parameters

scip	The SCIP instance the metdata relates to.
prop	The property data for the problem

Returns

SCIP_OKAY if storage worked, or an appropriate error message otherwise.

References createBlankConstraint(), getConshdlrDataIfExists(), PR_copyPropertyData(), and PROPERTY_NAME.

Referenced by readProblemInNonCIPFormat().

Here is the call graph for this function: