Class IloXmlWriter

Definition file: ilconcert/ilowriter.h

You can use an instance of IloXmlWriter to serialize an IloModel or an IloSolution in xml.

Constructor Summary
`public`	`IloXmlWriter(IloEnv, const char , const char )`
`public`	`IloXmlWriter(IloXmlWriterI *)`

Method Summary
`public void`	`addAttribute(IloXmlElement , const char , const char *)`
`public void`	`addCData(IloXmlElement , const char )`
`public void`	`addComment(IloXmlElement , const char )`
`public void`	`addElement(IloXmlElement *)`
`public void`	`addSerialized(IloInt)`
`public void`	`addSolutionSerialized(IloInt)`
`public void`	`addSubElement(IloXmlElement , IloXmlElement )`
`public void`	`addText(IloXmlElement , const char )`
`public IloXmlElement *`	`createElement(const char *)`
`public void`	`deleteAllocatedMemory(const char *)`
`public void`	`deleteAllocatedMemory(char *)`
`public IloEnv`	`getEnv()`
`public IloEnvI *`	`getEnvImpl()`
`public const char *`	`getfileName()`
`public IloXmlElement *`	`getRoot()`
`public IloIntArray *`	`getSerialized()`
`public IloIntArray *`	`getSolutionSerialized()`
`public const char *`	`Int2String(const IloInt)`
`public const char *`	`IntArray2String(const IloIntArray)`
`public const char *`	`IntSet2String(const IloIntSet)`
`public IloBool`	`isSerialized(IloInt)`
`public IloBool`	`isSolutionSerialized(IloInt)`
`public const char *`	`Num2String(const IloNum)`
`public const char *`	`NumArray2String(const IloNumArray)`
`public const char *`	`NumSet2String(const IloNumSet)`
`public void`	`setfileName(const char *)`
`public IloInt`	`string2Int(const char *)`
`public void`	`writeDocument()`

Constructor Detail

IloXmlWriter

public IloXmlWriter(IloEnv env, const char * rootTag, const char * fileName)

This constructor creates an IloXmlWriter object and makes it part of the environment env.

The fileName is set to 0 by default.

IloXmlWriter

public IloXmlWriter(IloXmlWriterI * impl)

This constructor creates a XML writer object from its implementation object.

Method Detail

Int2String

public const char * Int2String(const IloInt number)

This member function converts the IloInt object number into a string, const char*.

IntArray2String

public const char * IntArray2String(const IloIntArray intArray)

This member function converts the IloIntArray object intArray into a string, const char*.

IntSet2String

public const char * IntSet2String(const IloIntSet intSet)

This member function converts the IloIntSet object intSet into a string, const char*.

Num2String

public const char * Num2String(const IloNum number)

This member function converts the IloNum object number into a string, const char*.

NumArray2String

public const char * NumArray2String(const IloNumArray numArray)

This member function converts the IloNumArray object numArray into a string, const char*.

NumSet2String

public const char * NumSet2String(const IloNumSet numSet)

This member function converts the IloNumSet object numSet into a string, const char*.

addAttribute

public void addAttribute(IloXmlElement * element, const char * attribute, const char * value)

This member function adds an attribute of the specified value to the XML element.

addCData

public void addCData(IloXmlElement * element, const char * CData)

This member function adds a CDATA section to the XML element element.

addComment

public void addComment(IloXmlElement * element, const char * comment)

This member function adds comment to the XML element element.

addElement

public void addElement(IloXmlElement * element)

This member function adds the XML element element to the end of the XML.

addSerialized

public void addSerialized(IloInt id)

This member function informs the XML writer object that the model object has been serialized.

addSolutionSerialized

public void addSolutionSerialized(IloInt id)

This member function informs the XML writer object that the solution object has been serialized.

addSubElement

public void addSubElement(IloXmlElement * element, IloXmlElement * subElement)

This member function adds a child element, subElement, to the XML element element.

addText

public void addText(IloXmlElement * element, const char * text)

This member function adds text to the specified element.

createElement

public IloXmlElement * createElement(const char * element)

This member function creates an empty element with the given tag, element.

deleteAllocatedMemory

public void deleteAllocatedMemory(const char * pointer)

This member function frees the memory that has been allocated by the XML reader using, for example, the IloXmlWriter::Int2String member function.

deleteAllocatedMemory

public void deleteAllocatedMemory(char * pointer)

This member function frees the memory that has been allocated by the XML reader using, for example, the IloXmlWriter::Int2String member function.

getEnv

public IloEnv getEnv()

This member function gets the IloEnv of the object.

getEnvImpl

public IloEnvI * getEnvImpl()

This member function gets the implemention of the IloEnv of the object.

getRoot

public IloXmlElement * getRoot()

This member function gets the root XML element of the XML document.

getSerialized

public IloIntArray * getSerialized()

This member function gets the IDs of the serialized objects of an IloModel.

getSolutionSerialized

public IloIntArray * getSolutionSerialized()

This member function gets the IDs of the serialized objects of an IloSolution.

getfileName

public const char * getfileName()

This member function returns the name of the XML file

isSerialized

public IloBool isSerialized(IloInt id)

This member function checks whether an object has been serialized.

isSolutionSerialized

public IloBool isSolutionSerialized(IloInt id)

This member function checks whether a solution object has already been serialized.

setfileName

public void setfileName(const char * fileName)

This member function specifies fileName as the name of the XML file.

string2Int

public IloInt string2Int(const char * string)

This member function converts string into an IloInt.

writeDocument

public void writeDocument()

This member function outputs the XML to the file specified in the constructor or using the setFileName method. If null, this member function outputs on the cout io.