C# Class ATMLModelLibrary.model.equipment.InstrumentDescription

Inheritance: HardwareItemDescription
Datei anzeigen Open project: UtrsSoftware/ATMLWorkBench Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
Deserialize ( Stream s ) : InstrumentDescription
Deserialize ( string input ) : InstrumentDescription
Deserialize ( string input, InstrumentDescription &obj ) : bool
Deserialize ( string input, InstrumentDescription &obj, Exception &exception ) : bool

Deserializes workflow markup into an InstrumentDescription object

GetAtmlDocumentType ( ) : dbDocument.DocumentType
GetAtmlFileContext ( ) : string
GetAtmlFileDescription ( ) : string
GetAtmlFileName ( ) : string
GetAtmlFileType ( ) : AtmlFileType
GetAtmlId ( ) : string
GetAtmlName ( ) : string
IsDeleted ( bool deleted = null ) : bool
LoadFromFile ( string fileName ) : InstrumentDescription
LoadFromFile ( string fileName, InstrumentDescription &obj ) : bool
LoadFromFile ( string fileName, InstrumentDescription &obj, Exception &exception ) : bool

Deserializes xml markup from file into an InstrumentDescription object

SaveToFile ( string fileName, Exception &exception ) : bool

Serializes current InstrumentDescription object into file

SaveToFile ( string fileName ) : void
Serialize ( ) : string

Serializes current InstrumentDescription object into an XML string

ShouldSerializeBuses ( ) : bool

Test whether Buses should be serialized

ShouldSerializePaths ( ) : bool

Test whether Paths should be serialized

ShouldSerializePowerOnDefaults ( ) : bool

Test whether PowerOnDefaults should be serialized

ShouldSerializeResources ( ) : bool

Test whether Resources should be serialized

Validate ( SchemaValidationResult errors ) : bool

Method Details

Deserialize() public static method

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

Deserialize() public static method

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

Deserialize() public static method

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

Deserialize() public static method

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

GetAtmlDocumentType() public method

public GetAtmlDocumentType ( ) : dbDocument.DocumentType
return dbDocument.DocumentType

GetAtmlFileContext() public method

public GetAtmlFileContext ( ) : string
return string

GetAtmlFileDescription() public method

public GetAtmlFileDescription ( ) : string
return string

GetAtmlFileName() public method

public GetAtmlFileName ( ) : string
return string

GetAtmlFileType() public method

public GetAtmlFileType ( ) : AtmlFileType
return AtmlFileType

GetAtmlId() public method

public GetAtmlId ( ) : string
return string

GetAtmlName() public method

public GetAtmlName ( ) : string
return string

IsDeleted() public method

public IsDeleted ( bool deleted = null ) : bool
deleted bool
return bool

LoadFromFile() public static method

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

LoadFromFile() public static method

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

LoadFromFile() public static method

Deserializes xml markup from file into an InstrumentDescription object
public static LoadFromFile ( string fileName, InstrumentDescription &obj, Exception &exception ) : bool
fileName string string xml file to load and deserialize
obj InstrumentDescription Output InstrumentDescription object
exception Exception output Exception value if deserialize failed
return bool

SaveToFile() public method

Serializes current InstrumentDescription object into file
public SaveToFile ( string fileName, Exception &exception ) : bool
fileName string full path of outupt xml file
exception 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 InstrumentDescription object into an XML string
public Serialize ( ) : string
return string

ShouldSerializeBuses() public method

Test whether Buses should be serialized
public ShouldSerializeBuses ( ) : bool
return bool

ShouldSerializePaths() public method

Test whether Paths should be serialized
public ShouldSerializePaths ( ) : bool
return bool

ShouldSerializePowerOnDefaults() public method

Test whether PowerOnDefaults should be serialized
public ShouldSerializePowerOnDefaults ( ) : bool
return bool

ShouldSerializeResources() public method

Test whether Resources should be serialized
public ShouldSerializeResources ( ) : bool
return bool

Validate() public method

public Validate ( SchemaValidationResult errors ) : bool
errors SchemaValidationResult
return bool