Class Writer
This defines the main interface for a configuration writer object.
Implements
Namespace: ABB.Robotics.Controllers.Configuration
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public abstract class Writer : IDisposable
Constructors
Writer()
Initializes a new writer object.
Declaration
protected Writer()
Methods
Dispose()
Disposes the current writer object.
Declaration
public void Dispose()
Dispose(Boolean)
Dispose extension point.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
Boolean | disposing | True if called by dispose, otherwise false. |
Flush()
Flushes the content into the underlaying stream.
Declaration
public virtual void Flush()
WriteAttribute(String)
Writes an attribute.
Declaration
public void WriteAttribute(string name)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name. |
WriteAttribute(String, String)
Writes an attribute.
Declaration
public virtual void WriteAttribute(string name, string value)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name. |
String | value | The value. |
WriteEndInstance()
Ends the current instance.
Declaration
public virtual void WriteEndInstance()
WriteEndType()
Ends the current type.
Declaration
public virtual void WriteEndType()
WriteHeader(String, String)
Writes a simple header.
Declaration
public virtual void WriteHeader(string domain, string version)
Parameters
Type | Name | Description |
---|---|---|
String | domain | The domain. |
String | version | The configuration format version. |
WriteHeader(String, String, String, String)
Writes a versioned header.
Declaration
public virtual void WriteHeader(string domain, string cfgVersion, string ctrlHighVersion, string ctrlLowVersion)
Parameters
Type | Name | Description |
---|---|---|
String | domain | The domain. |
String | cfgVersion | The configuration format version. |
String | ctrlHighVersion | The high controller version. |
String | ctrlLowVersion | The low controller version. |
WriteProperties(String)
Writes properties.
Declaration
public virtual void WriteProperties(string properties)
Parameters
Type | Name | Description |
---|---|---|
String | properties | The properties/header comments of the file. |
WriteStartInstance()
Starts a new instance.
Declaration
public virtual void WriteStartInstance()
WriteStartType(String)
Writes a configuration type.
Declaration
public void WriteStartType(string name)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the type. |
WriteStartType(String, String)
Writes a configuration type.
Declaration
public virtual void WriteStartType(string name, string alias)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the type. |
String | alias | The type alias. |