wx.Build.RefToProject Class Reference

Inheritance diagram for wx.Build.RefToProject:

List of all members.

Public Member Functions
int	CompareTo (object obj)
override bool	Equals (object obj)
override int	GetHashCode ()
ICollection < RefToProject >	GetProjects ()
System.Xml.Schema.XmlSchema	GetSchema ()
DateTime	GetValidity ()
DateTime	GetValidityDemand ()
void	ReadXml (System.Xml.XmlReader reader)
	RefToProject (BuildProject p)
	RefToProject ()
override string	ToString ()
void	WriteXml (System.Xml.XmlWriter writer)
Static Public Member Functions
static implicit	operator RefToProject (BuildProject p)
Properties
BuildProject	Project [get]

---

Detailed Description

This is a wrapper around a BuildProject that makes this instance a build product. Projects often refer to another project as prerequisite - projects can be build products. This wrapper turns a project into a build product.

Why using a wrapper? A project shall be stred only once. In contrast, references to a project may occur more than once.

---

Constructor & Destructor Documentation

wx.Build.RefToProject.RefToProject

(

)

Use this only to create an instance for ReadXml().

wx.Build.RefToProject.RefToProject

(

BuildProject

p

)

---

Member Function Documentation

int wx.Build.RefToProject.CompareTo

(

object

obj

)

Compares w.r.t. the encaspulated project if both are of class RefToProject.

Parameters:

obj

The object that will be compared

Returns:

-1 if this is smaller than the argument, 0 if both equal, 1 if the argument is larger.

override bool wx.Build.RefToProject.Equals

(

object

obj

)

override int wx.Build.RefToProject.GetHashCode

(

)

This is the hash of the encapsulated project.

Returns:

ICollection<RefToProject> wx.Build.RefToProject.GetProjects

(

)

Returns a collection including exclusively the wrapped project.

Returns:

Implements wx.Build.IBuildProduct.

System.Xml.Schema.XmlSchema wx.Build.RefToProject.GetSchema

(

)

DateTime wx.Build.RefToProject.GetValidity

(

)

Returns validity timstamp of this object. Whenever this is equal or later than all prerequisites, this is considered consistent with the prerequisites on rebuilding.

Implements wx.Build.IBuildObject.

DateTime wx.Build.RefToProject.GetValidityDemand

(

)

This is the counterpart of the Validity . If this occurs as a prerequisite, this shall be compared with the Validity of the target in order to assess whether rebuild is necessary or not.

Implements wx.Build.IBuildObject.

static implicit wx.Build.RefToProject.operator RefToProject

(

BuildProject

p

)

[static]

Implicitely converts a project into a ref to a project creating a reference to the project.

Parameters:

p

The project that shall be referenced

Returns:

A reference to the project.

void wx.Build.RefToProject.ReadXml

(

System.Xml.XmlReader

reader

)

Will create a project using BuildProject.LoadRefFrom(reader).

Parameters:

reader

The source where the XML serialization will be read from.

override string wx.Build.RefToProject.ToString

(

)

void wx.Build.RefToProject.WriteXml

(

System.Xml.XmlWriter

writer

)

Calls BuildProject.WriteRefXml().

Parameters:

writer

the destination where the XML serialization will be written to.

---

Property Documentation

BuildProject wx.Build.RefToProject.Project [get]

This is the encapsulated project.

---