C# Class ATMLModelLibrary.model.equipment.HardwareItemDescription

Inheritance: ATMLModelLibrary.model.common.ItemDescription

Datei anzeigen Open project: UtrsSoftware/ATMLWorkBench Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
AddDocument ( Document document ) : void
Deserialize ( Stream s ) : HardwareItemDescription
Deserialize ( string input ) : HardwareItemDescription
Deserialize ( string input, HardwareItemDescription &obj ) : bool
Deserialize ( string input, HardwareItemDescription &obj, Exception &exception ) : bool	Deserializes workflow markup into an HardwareItemDescription object
FindDoument ( String guid ) : Document
HasDoument ( String guid ) : bool
LoadFromFile ( string fileName ) : HardwareItemDescription
LoadFromFile ( string fileName, HardwareItemDescription &obj ) : bool
LoadFromFile ( string fileName, HardwareItemDescription &obj, Exception &exception ) : bool	Deserializes xml markup from file into an HardwareItemDescription object
SaveToFile ( string fileName, Exception &exception ) : bool	Serializes current HardwareItemDescription object into file
SaveToFile ( string fileName ) : void
Serialize ( ) : string	Serializes current HardwareItemDescription object into an XML string
ShouldSerializeCalibrationRequirements ( ) : bool	Test whether CalibrationRequirements should be serialized
ShouldSerializeComponents ( ) : bool	Test whether Components should be serialized
ShouldSerializeConfigurationOptions ( ) : bool	Test whether ConfigurationOptions should be serialized
ShouldSerializeDocumentation ( ) : bool	Test whether Documentation should be serialized
ShouldSerializeErrors ( ) : bool	Test whether Errors should be serialized
ShouldSerializeFactoryDefaults ( ) : bool	Test whether FactoryDefaults should be serialized
ShouldSerializeInterface ( ) : bool	Test whether Interface should be serialized
ShouldSerializeNetworkList ( ) : bool	Test whether NetworkList should be serialized
ShouldSerializeParentComponents ( ) : bool	Test whether ParentComponents should be serialized
ShouldSerializePowerRequirements ( ) : bool	Test whether PowerRequirements should be serialized

Method Details

AddDocument() public method

public AddDocument ( Document document ) : void
document	ATMLModelLibrary.model.common.Document
return	void

Deserialize() public static method

public static Deserialize ( Stream s ) : HardwareItemDescription
s	Stream
return	HardwareItemDescription

Deserialize() public static method

public static Deserialize ( string input ) : HardwareItemDescription
input	string
return	HardwareItemDescription

Deserialize() public static method

public static Deserialize ( string input, HardwareItemDescription &obj ) : bool
input	string
obj	HardwareItemDescription
return	bool

Deserialize() public static method

Deserializes workflow markup into an HardwareItemDescription object

public static Deserialize ( string input, HardwareItemDescription &obj, Exception &exception ) : bool
input	string	string workflow markup to deserialize
obj	HardwareItemDescription	Output HardwareItemDescription object
exception	System.Exception	output Exception value if deserialize failed
return	bool

FindDoument() public method

public FindDoument ( String guid ) : Document
guid	String
return	ATMLModelLibrary.model.common.Document

HasDoument() public method

public HasDoument ( String guid ) : bool
guid	String
return	bool

LoadFromFile() public static method

public static LoadFromFile ( string fileName ) : HardwareItemDescription
fileName	string
return	HardwareItemDescription

LoadFromFile() public static method

public static LoadFromFile ( string fileName, HardwareItemDescription &obj ) : bool
fileName	string
obj	HardwareItemDescription
return	bool

LoadFromFile() public static method

Deserializes xml markup from file into an HardwareItemDescription object

public static LoadFromFile ( string fileName, HardwareItemDescription &obj, Exception &exception ) : bool
fileName	string	string xml file to load and deserialize
obj	HardwareItemDescription	Output HardwareItemDescription object
exception	System.Exception	output Exception value if deserialize failed
return	bool

SaveToFile() public method

Serializes current HardwareItemDescription object into file

public SaveToFile ( string fileName, Exception &exception ) : bool
fileName	string	full path of outupt xml file
exception	System.Exception	output Exception value if failed
return	bool

SaveToFile() public method

public SaveToFile ( string fileName ) : void
fileName	string
return	void

Serialize() public method

Serializes current HardwareItemDescription object into an XML string

public Serialize ( ) : string
return	string

ShouldSerializeCalibrationRequirements() public method

Test whether CalibrationRequirements should be serialized

public ShouldSerializeCalibrationRequirements ( ) : bool
return	bool

ShouldSerializeComponents() public method

Test whether Components should be serialized

public ShouldSerializeComponents ( ) : bool
return	bool

ShouldSerializeConfigurationOptions() public method

Test whether ConfigurationOptions should be serialized

public ShouldSerializeConfigurationOptions ( ) : bool
return	bool

ShouldSerializeDocumentation() public method

Test whether Documentation should be serialized

public ShouldSerializeDocumentation ( ) : bool
return	bool

ShouldSerializeErrors() public method

Test whether Errors should be serialized

public ShouldSerializeErrors ( ) : bool
return	bool

ShouldSerializeFactoryDefaults() public method

Test whether FactoryDefaults should be serialized

public ShouldSerializeFactoryDefaults ( ) : bool
return	bool

ShouldSerializeInterface() public method

Test whether Interface should be serialized

public ShouldSerializeInterface ( ) : bool
return	bool

ShouldSerializeNetworkList() public method

Test whether NetworkList should be serialized

public ShouldSerializeNetworkList ( ) : bool
return	bool

ShouldSerializeParentComponents() public method

Test whether ParentComponents should be serialized

public ShouldSerializeParentComponents ( ) : bool
return	bool

ShouldSerializePowerRequirements() public method

Test whether PowerRequirements should be serialized

public ShouldSerializePowerRequirements ( ) : bool
return	bool