Namespace List
The namespaces specified in this document are:
Namespace : AStar.Common
AStar.Common Type List
Interfaces
Type | Summary |
---|
INamed | The INamed Interface, for a named item in the NamedItemCollection. |
Structs
Type | Summary |
---|
Measurand | The Measurand, value with the associated standard uncertainty (su / esd), in the double precision. |
Classes
AStar.Common Interfaces
INamed Interface
Summary
public interface INamed
The INamed Interface, for a named item in the NamedItemCollection.
Property Members
Name | Access | Summary |
---|
Name : String | public | The name of the item, assumed to be immutable after the item is added to a NamedItemCollection, or the behavior is undefined. |
AStar.Common Structs
Measurand Structure
Summary
public structure Measurand : System.IFormattable
The Measurand, value with the associated standard uncertainty (su / esd), in the double precision.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
Measurand() | public | Creates a new instance of Measurand with the specified value and standard uncertainty. |
Measurand() | public | Creates a new instance of Measurand from the string representation. |
Field Members
Name | Access | Summary |
---|
Su : Double | public | The associated standard uncertainty, (aka. esd). |
Value : Double | public | The measurand value. |
Method Members
Name | Access | Summary |
---|
Parse() : Measurand | public | Converts the string to a Measurand instance. |
ToString() : String | public | Converts the Measurand instance to its string representation. |
ToString() : String | public | Converts the Measurand instance to its string representation. |
ToString() : String | public | Converts the Measurand instance to its string representation. |
ToString() : String | public | Converts the Measurand instance to its string representation. |
AStar.Common Classes
NamedItemCollection<T> Class
Summary
public class NamedItemCollection : System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
The NamedItemCollection Class.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
NamedItemCollection() | public | The default constructor. |
NamedItemCollection() | public | Constructor with the items to be copied. |
NamedItemCollection() | public | Constructor with the initial capacity specified. |
Field Members
Name | Access | Summary |
---|
km : String,`0} | protected | |
vs : List{`0} | protected | |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | The total number of items the internal list can hold without resizing. |
Count : Int32 | public | The number of items in the collection. |
IsReadOnly : Boolean | public | |
Item : `0 | public | Gets/Sets an item by the order in the collection. |
Item : `0 | public | Gets/Sets an item by the name. |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | Adds an item to the collection. |
AddRange() : Void | protected | Adds the items to the collection. |
Clear() : Void | public | Clears all items in the collection. |
Contains() : Boolean | public | Checks whether the collection contains the item. [X] |
Contains() : Boolean | public | Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | Copies the entire collection to a compatible one-dimensional array, starting at the beginning of the target array. |
CopyTo() : Void | public | Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. |
CopyTo() : Void | public | Copies a range of items from the collection to a compatible one-dimensional array, starting at the specified index of the target array. |
Get() : `0 | public | Gets the item with the specified name. |
GetEnumerator() : IEnumerator{`0} | public | The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
IndexOf() : Int32 | public | Gets the index of the item. [X] |
IndexOf() : Int32 | public | Gets the index of the item with the specified name. |
Insert() : Void | public | Inserts item in the specified index. |
InsertRange() : Void | protected | Inserts the items in the specified index. |
Remove() : Boolean | public | Removes the item from the collection. |
Remove() : Boolean | public | Removes the item with the name from the collection. |
RemoveAt() : Boolean | public | Removes the item at the index. |
RemoveRange() : Boolean | protected | . |
ToArray() : `0[] | public | Copies the items of the collection to a new array. |
TryGet() : Boolean | public | Gets the item with the specified name, (using TryGetValue of Dictionary). |
TryGetR() : Boolean | public | Gets the item with the specified name. |
NameDuplicateException Class
Summary
public class NameDuplicateException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
NameDuplicateException() | public | Initializes a new instance of the class. |
NameDuplicateException() | public | |
Property Members
Method Members
NameNotFoundException Class
Summary
public class NameNotFoundException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
NameNotFoundException() | public | Initializes a new instance of the class. |
NameNotFoundException() | public | |
Property Members
Method Members
Namespace : AStar.Star
AStar.Star Type List
Enumerations
Type | Summary |
---|
StarFieldType | The type of a field, primitive or loop. |
StarPRErrorCode | . |
StarPWErrorCode | . |
StarValueLiteral | A enum of the literal forms of STAR values. A STAR value literal is the representation of a STAR value within the source file: the non-quoted (NQ), single-quoted (SQ), double-quoted (DQ) and semi-colon (SC) delimited forms. The reading process may optionally mark the original literal form of a StarValue, in the literal field; and the writing process may write STAR file according to the prefered literal, specified by the Literal field. |
StarXDataType | . |
Classes
AStar.Star Enumerations
StarFieldType Enumeration
Summary
public enumeration StarFieldType
The type of a field, primitive or loop.
Enumeration Members
Field | Summary |
---|
Loop | A loop(ed) field. |
Primitive | A primitive field. |
StarXDataType Enumeration
Summary
public enumeration StarXDataType
.
Enumeration Members
Field | Summary |
---|
FrameRef | |
Value | |
XList | |
StarValueLiteral Enumeration
Summary
public enumeration StarValueLiteral
A enum of the literal forms of STAR values. A STAR value literal is the representation of a STAR value within the source file: the non-quoted (NQ), single-quoted (SQ), double-quoted (DQ) and semi-colon (SC) delimited forms. The reading process may optionally mark the original literal form of a StarValue, in the literal field; and the writing process may write STAR file according to the prefered literal, specified by the Literal field.
Enumeration Members
StarPWErrorCode Enumeration
Summary
public enumeration StarPWErrorCode
.
Enumeration Members
Field | Summary |
---|
InvalidName | |
InvalidTag | |
InvalidValue | |
LoopNotIntegral | |
StarPRErrorCode Enumeration
Summary
public enumeration StarPRErrorCode
.
Enumeration Members
Field | Summary |
---|
DuplicateBlockName | |
DuplicateFieldName | |
DuplicateFrameName | |
InvalidChar | |
LoopNotIntegral | |
MissingQuote | |
UnexpectedInBlock | |
UnexpectedInFrame | |
UnexpectedInTop | |
AStar.Star Classes
StarPack Class
Summary
public class StarPack : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
The top-level collection of STAR data objects, a packing of data blocks in a STAR file.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarPack() | public | Creates an empty StarPack instance. |
StarPack() | public | Creates a new StarPack instance from the STAR file. |
Field Members
Name | Access | Summary |
---|
km : StarBlock} | protected | (from AStar.Common.NamedItemCollection`1) |
vs : StarBlock} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
Global : StarBlock | public | The global data block. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : StarBlock | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : StarBlock | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Common.NamedItemCollection`1) |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Common.NamedItemCollection`1) Clears all items in the collection. |
Clone() : StarPack | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
Get() : StarBlock | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetEnumerator() : StarBlock} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Common.NamedItemCollection`1) |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Load() : Void | public | . |
Load() : Void | public | . |
Load() : Void | public | Loads data from a STAR file. |
Load() : Void | public | Loads data from a STAR file. |
Merge() : Void | public | . |
Merge() : Void | public | . |
Merge() : StarPack | public | . |
Parse() : Void | public | Parses the STAR source string. |
Parse() : Void | public | . |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection. |
RemoveAt() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item at the index. |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
Save() : Void | public | . |
Save() : Void | public | . |
Save() : Void | public | Saves the data to a STAR file. |
Save() : Void | public | . |
Split() : StarPack[] | public | . |
Split() : StarPack[] | public | . |
ToArray() : StarBlock[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
ToText() : String | public | Returns a STAR source string which represents the data in the StarPack object. |
ToText() : String | public | . |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
StarFieldCollection Class
Summary
public abstract class StarFieldCollection : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable, AStar.Common.INamed
A collection of StarField objects.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarFieldCollection() | protected | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
comment : String | familyOrAssembly | |
km : StarField} | protected | (from AStar.Common.NamedItemCollection`1) |
name : String | familyOrAssembly | |
vs : StarField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Loops : StarLoop} | public | . |
Name : String | public | The name of the collection, used as the identifier of a StarFrame or StarBlock instance. |
Primitives : StarPrimitiveField} | public | . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | This method overrides the base class's definition, to prevent adding a loop field. |
Add() : Void | public | Adds a data loop to the collection. |
Add() : Void | public | Adds a primitive field to the collection. |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
Contains() : Boolean | public | . |
Contains() : Boolean | public | . |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : Void | public | Creates a primitive field in the collection. |
Get() : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetData() : StarXData | public | . |
GetData() : StarXData | public | . |
GetEnumerator() : StarField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetLevel() : Int32 | public | . |
GetList() : StarXList | public | . |
GetList() : StarXList | public | . |
GetList() : StarXList | public | . |
GetLoop() : StarLoop | public | Gets the loop which contains a field with the name. |
GetLoop() : StarLoop | public | Gets the loop which contains fields with the name and names. |
GetRef() : StarFrameRef | public | . |
GetRef() : StarFrameRef | public | . |
GetValue() : StarValue | public | . |
GetValue() : StarValue | public | . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | This method overrides the base class's definition, to prevent inserting a loop field. |
Insert() : Void | public | Inserts a data loop to the collection. |
Insert() : Void | public | . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | . |
Query() : Boolean | public | |
Query() : Boolean | public | |
Query() : Boolean | public | |
Query() : Boolean | public | |
Remove() : Boolean | public | . |
Remove() : Boolean | public | . |
RemoveAt() : Boolean | public | . |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
SetData() : StarXData | public | . |
SetList() : StarXList | public | . |
SetRef() : StarFrameRef | public | . |
SetValue() : StarValue | public | . |
ToArray() : StarField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
StarBlock Class
Summary
public class StarBlock : StarFieldCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable, AStar.Common.INamed
A STAR data block.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarBlock() | public | Creates a new StarBlock instance, (for a global_ block). |
StarBlock() | public | Creates a new StarBlock instance. |
StarBlock() | public | . |
Field Members
Name | Access | Summary |
---|
comment : String | familyOrAssembly | (from AStar.Star.StarFieldCollection) |
Frames : StarFrameCollection | public | . |
km : StarField} | protected | (from AStar.Common.NamedItemCollection`1) |
name : String | familyOrAssembly | (from AStar.Star.StarFieldCollection) |
vs : StarField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | (from AStar.Star.StarFieldCollection) . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Loops : StarLoop} | public | (from AStar.Star.StarFieldCollection) . |
Name : String | public | (from AStar.Star.StarFieldCollection) The name of the collection, used as the identifier of a StarFrame or StarBlock instance. |
Primitives : StarPrimitiveField} | public | (from AStar.Star.StarFieldCollection) . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent adding a loop field. |
Add() : Void | public | (from AStar.Star.StarFieldCollection) Adds a data loop to the collection. |
Add() : Void | public | (from AStar.Star.StarFieldCollection) Adds a primitive field to the collection. |
AddFrame() : Void | public | eq. to .Frames.Add(frame). |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Star.StarFieldCollection) . |
Clone() : StarBlock | public | |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
Contains() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
Contains() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
ContainsFrame() : Boolean | public | eq. to .Frames.Contains(name). |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : Void | public | (from AStar.Star.StarFieldCollection) Creates a primitive field in the collection. |
Get() : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetData() : StarXData | public | (from AStar.Star.StarFieldCollection) . |
GetData() : StarXData | public | (from AStar.Star.StarFieldCollection) . |
GetEnumerator() : StarField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetFrame() : StarFrame | public | . |
GetFrame() : StarFrame | public | eq. to .Frames[name]. |
GetLevel() : Int32 | public | (from AStar.Star.StarFieldCollection) . |
GetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
GetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
GetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
GetLoop() : StarLoop | public | (from AStar.Star.StarFieldCollection) Gets the loop which contains a field with the name. |
GetLoop() : StarLoop | public | (from AStar.Star.StarFieldCollection) Gets the loop which contains fields with the name and names. |
GetRef() : StarFrameRef | public | (from AStar.Star.StarFieldCollection) . |
GetRef() : StarFrameRef | public | (from AStar.Star.StarFieldCollection) . |
GetValue() : StarValue | public | (from AStar.Star.StarFieldCollection) . |
GetValue() : StarValue | public | (from AStar.Star.StarFieldCollection) . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field. |
Insert() : Void | public | (from AStar.Star.StarFieldCollection) Inserts a data loop to the collection. |
Insert() : Void | public | (from AStar.Star.StarFieldCollection) . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | |
Merge() : Void | public | |
Merge() : Void | public | (from AStar.Star.StarFieldCollection) . |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Remove() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
Remove() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
RemoveAt() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
RemoveFrame() : Boolean | public | . |
RemoveFrame() : Boolean | public | eq. to .Frames.Remove(name). |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
SetData() : StarXData | public | (from AStar.Star.StarFieldCollection) . |
SetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
SetRef() : StarFrameRef | public | (from AStar.Star.StarFieldCollection) . |
SetValue() : StarValue | public | (from AStar.Star.StarFieldCollection) . |
ToArray() : StarField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
StarFrameCollection Class
Summary
public class StarFrameCollection : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
A collection of StarFrame objects.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarFrameCollection() | public | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
km : StarFrame} | protected | (from AStar.Common.NamedItemCollection`1) |
vs : StarFrame} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : StarFrame | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : StarFrame | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Common.NamedItemCollection`1) |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Common.NamedItemCollection`1) Clears all items in the collection. |
Clone() : StarFrameCollection | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
Get() : StarFrame | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetEnumerator() : StarFrame} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Common.NamedItemCollection`1) |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | . |
Merge() : Void | public | . |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection. |
RemoveAt() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item at the index. |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
ToArray() : StarFrame[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
StarFrame Class
Summary
public class StarFrame : StarFieldCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable, AStar.Common.INamed
A STAR save-frame object.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarFrame() | public | Creates a new StarFrame instance. |
StarFrame() | public | . |
Field Members
Name | Access | Summary |
---|
comment : String | familyOrAssembly | (from AStar.Star.StarFieldCollection) |
km : StarField} | protected | (from AStar.Common.NamedItemCollection`1) |
name : String | familyOrAssembly | (from AStar.Star.StarFieldCollection) |
vs : StarField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | (from AStar.Star.StarFieldCollection) . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Loops : StarLoop} | public | (from AStar.Star.StarFieldCollection) . |
Name : String | public | (from AStar.Star.StarFieldCollection) The name of the collection, used as the identifier of a StarFrame or StarBlock instance. |
Primitives : StarPrimitiveField} | public | (from AStar.Star.StarFieldCollection) . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent adding a loop field. |
Add() : Void | public | (from AStar.Star.StarFieldCollection) Adds a data loop to the collection. |
Add() : Void | public | (from AStar.Star.StarFieldCollection) Adds a primitive field to the collection. |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Star.StarFieldCollection) . |
Clone() : StarFrame | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
Contains() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
Contains() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : Void | public | (from AStar.Star.StarFieldCollection) Creates a primitive field in the collection. |
Get() : StarField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetData() : StarXData | public | (from AStar.Star.StarFieldCollection) . |
GetData() : StarXData | public | (from AStar.Star.StarFieldCollection) . |
GetEnumerator() : StarField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetLevel() : Int32 | public | (from AStar.Star.StarFieldCollection) . |
GetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
GetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
GetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
GetLoop() : StarLoop | public | (from AStar.Star.StarFieldCollection) Gets the loop which contains a field with the name. |
GetLoop() : StarLoop | public | (from AStar.Star.StarFieldCollection) Gets the loop which contains fields with the name and names. |
GetRef() : StarFrameRef | public | (from AStar.Star.StarFieldCollection) . |
GetRef() : StarFrameRef | public | (from AStar.Star.StarFieldCollection) . |
GetValue() : StarValue | public | (from AStar.Star.StarFieldCollection) . |
GetValue() : StarValue | public | (from AStar.Star.StarFieldCollection) . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field. |
Insert() : Void | public | (from AStar.Star.StarFieldCollection) Inserts a data loop to the collection. |
Insert() : Void | public | (from AStar.Star.StarFieldCollection) . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | (from AStar.Star.StarFieldCollection) . |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Query() : Boolean | public | (from AStar.Star.StarFieldCollection) |
Remove() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
Remove() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
RemoveAt() : Boolean | public | (from AStar.Star.StarFieldCollection) . |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
SetData() : StarXData | public | (from AStar.Star.StarFieldCollection) . |
SetList() : StarXList | public | (from AStar.Star.StarFieldCollection) . |
SetRef() : StarFrameRef | public | (from AStar.Star.StarFieldCollection) . |
SetValue() : StarValue | public | (from AStar.Star.StarFieldCollection) . |
ToArray() : StarField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
StarField Class
Summary
public abstract class StarField : AStar.Common.INamed
The abstract base class of StarPrimitiveField and StarLoopField.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarField() | protected | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
name : String | familyOrAssembly | |
Property Members
Name | Access | Summary |
---|
Data : StarXData | public | |
Level : Int32 | public | |
List : StarXList | public | |
Name : String | public | . |
Ref : StarFrameRef | public | |
Type : StarFieldType | public | |
Value : StarValue | public | |
Method Members
StarPrimitiveField Class
Summary
public class StarPrimitiveField : StarField, AStar.Common.INamed
A primitive field, represents a tag - value pair in the source. The 0-dimensional (.Level == 0) data container holding a single StarValue.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarPrimitiveField() | public | Creates a StarPrimitiveField instance with the 'name' and StarValue.Unknown(?). |
StarPrimitiveField() | public | Creates a StarPrimitiveField instance with the 'name' and 'val'. |
Field Members
Name | Access | Summary |
---|
name : String | familyOrAssembly | (from AStar.Star.StarField) |
Property Members
Name | Access | Summary |
---|
Data : StarXData | public | The associated field data. |
Level : Int32 | public | Returns 0. |
List : StarXList | public | The associated field data (StarValueList), always null. |
Name : String | public | (from AStar.Star.StarField) . |
Ref : StarFrameRef | public | The associated field data (StarFrameRef). |
Type : StarFieldType | public | Returns StarFieldType.Primitive. |
Value : StarValue | public | The associated field data (StarValue). |
Method Members
Name | Access | Summary |
---|
Clone() : StarPrimitiveField | public | . |
StarLoop Class
Summary
public class StarLoop : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
A collection of StarLoopField objects, grouping the looped fields in the StarFieldCollection object, represents a STAR loop structure in the source.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarLoop() | public | Creates an empty StarLoop instance, it's not integral until the first field added and the first row filled in. Note the StarLoop instance is not integral if it contains no fields and data, or it's data is not aligned. |
StarLoop() | public | . |
StarLoop() | public | . |
StarLoop() | public | . |
StarLoop() | public | . |
StarLoop() | public | . |
Field Members
Name | Access | Summary |
---|
km : StarLoopField} | protected | (from AStar.Common.NamedItemCollection`1) |
vs : StarLoopField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
ColumnCount : Int32 | public | . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsIntegral : Boolean | public | Indicates whether the loop structure is integral. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : StarXData | public | Gets/Sets a value at the specified row and column indexes. |
Item : StarXData | public | Gets/Sets a value specified by the row index and field name. |
Level : Int32 | public | . |
Loop : StarLoop | public | . |
RowCount : Int32 | public | . |
Rows : StarLoopRow} | public | . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | . |
Add() : Void | public | . |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
AddRow() : StarLoopRow | public | . |
CheckIntegrity() : Boolean | public | Checks the integrity of the StarLoop. 1) There is at least one StarLoopField in the StarLoop; 2) All those StarLoopFields contain the same Count of values (RowCount); 3) There is at least one row in the StarLoop. |
Clear() : Void | public | . |
Clone() : StarLoop | public | Note the Fill state is not cloned. |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : StarLoopField | public | . |
Fill() : Boolean | public | . |
Get() : StarLoopField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetEnumerator() : StarLoopField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetLoop() : StarLoop | public | Gets the inner loop specified by the name and row index. e.g., for the loop:loop_
_d1
loop_
_d21
_d22
1_0
21_0_0 22_0_0
21_0_1 22_0_1 stop_
1_1
21_1_0 22_1_0
21_1_1 22_1_1 stop_ GetLoop("_d21", 1) or GetLoop("_d22", 1) will return a StarLoop instance the structure as:loop_
_d21
_d22
21_1_0 22_1_0
21_1_1 22_1_1 Note modification on the inner loop will also affect its parents. |
GetRow() : StarLoopRow | public | . |
GetVariant() : StarLoop | public | Gets the StarLoop variant, with the similar structure but in a different level. |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | . |
Insert() : Void | public | . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
InsertRow() : StarLoopRow | public | . |
Remove() : Boolean | public | . |
Remove() : Boolean | public | . |
RemoveAt() : Boolean | public | . |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
RemoveRowAt() : Boolean | public | . |
Stop() : Void | public | . |
ToArray() : StarLoopField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
StarLoopField Class
Summary
public class StarLoopField : StarField, AStar.Common.INamed
A STAR loop field.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarLoopField() | public | . |
StarLoopField() | public | . |
Field Members
Name | Access | Summary |
---|
name : String | familyOrAssembly | (from AStar.Star.StarField) |
Property Members
Name | Access | Summary |
---|
Data : StarXData | public | . |
Level : Int32 | public | The level of the field. |
List : StarXList | public | . |
Loop : StarLoop | public | The StarLoop instance which directly contains the StarLoopField instance. |
Name : String | public | (from AStar.Star.StarField) . |
Ref : StarFrameRef | public | . |
Type : StarFieldType | public | The type of the field, always returns StarFieldType.Loop. |
Value : StarValue | public | . |
Method Members
Name | Access | Summary |
---|
Clone() : StarLoopField | public | . |
GetLoop() : StarLoop | public | . |
GetVariant() : StarLoopField | public | . |
StarLoopRow Class
Summary
public class StarLoopRow
.
Property Members
Name | Access | Summary |
---|
Count : Int32 | public | . |
Item : StarValue | public | . |
Item : StarValue | public | . |
Loop : StarLoop | public | . |
Position : Int32 | public | . |
Method Members
Name | Access | Summary |
---|
Contains() : Boolean | public | . |
StarXData Class
Summary
public abstract class StarXData
Represents the data in a field, atomic data (level 0) or list.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarXData() | protected | Initializes a new instance of the class. |
Property Members
Name | Access | Summary |
---|
Level : Int32 | public | . |
Type : StarXDataType | public | The type ID of StarXData. |
Method Members
Name | Access | Summary |
---|
AsList() : StarXList | public | . |
AsRef() : StarFrameRef | public | . |
AsValue() : StarValue | public | . |
StarValue Class
Summary
public class StarValue : StarXData, System.IEquatable, System.IComparable
StarValue, the premitive data type of a STAR file.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarValue() | public | Initializes a new instance of StarValue from the instance of Measurand. |
StarValue() | public | Initializes a new instance of StarValue from the double. |
StarValue() | public | Initializes a new instance of StarValue from the (Int32) integer. |
StarValue() | public | Initializes a new instance of StarValue from the (Int64) integer. |
StarValue() | public | Initializes a new instance of StarValue from the string. |
StarValue() | public | Initializes a new instance of StarValue from the string. |
Field Members
Name | Access | Summary |
---|
Default : StarValue | public | (.). |
Unknown : StarValue | public | (?). |
Property Members
Name | Access | Summary |
---|
Level : Int32 | public | . |
Literal : StarValueLiteral | public | Marks the original or prefered literal form of the StarRealValue instance. |
Type : StarXDataType | public | . |
Method Members
Name | Access | Summary |
---|
AsList() : StarXList | public | . |
AsRef() : StarFrameRef | public | . |
AsValue() : StarValue | public | . |
Clone() : StarValue | public | . |
CompareTo() : Int32 | public | . |
Equals() : Boolean | public | . |
Equals() : Boolean | public | . |
GetHashCode() : Int32 | public | . |
IsDefault() : Boolean | public | . |
IsUnknown() : Boolean | public | . |
ToInt32() : Int32 | public | Converts the StarValue instance to an (Int32) integer. |
ToInt64() : Int64 | public | Converts the StarValue instance to an (Int64) integer. |
ToLower() : StarValue | public | . |
ToMeasurand() : Measurand | public | Converts the StarValue instance to a Measurand instance. |
ToNumber() : Double | public | Converts the StarValue instance to a number (double). |
ToString() : String | public | Converts the StarValue instance to a string. |
ToUpper() : StarValue | public | . |
StarFrameRef Class
Summary
public class StarFrameRef : StarXData
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarFrameRef() | public | . |
Property Members
Name | Access | Summary |
---|
Level : Int32 | public | . |
Type : StarXDataType | public | . |
Method Members
Name | Access | Summary |
---|
AsList() : StarXList | public | . |
AsRef() : StarFrameRef | public | . |
AsValue() : StarValue | public | . |
Clone() : StarFrameRef | public | . |
ToString() : String | public | . |
StarXList Class
Summary
public class StarXList : StarXData, System.Collections.Generic.IList, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
StarValueList.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarXList() | public | . |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
StarXList() | public | |
Property Members
Name | Access | Summary |
---|
Count : Int32 | public | . |
IsReadOnly : Boolean | public | . |
Item : StarXData | public | . |
Level : Int32 | public | . |
Type : StarXDataType | public | . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | . |
AsList() : StarXList | public | . |
AsRef() : StarFrameRef | public | . |
AsValue() : StarValue | public | . |
Clear() : Void | public | . |
Clone() : StarXList | public | . |
Contains() : Boolean | public | . |
CopyTo() : Void | public | . |
CopyTo() : Void | public | . |
GetEnumerator() : StarXData} | public | . |
IndexOf() : Int32 | public | . |
Insert() : Void | public | . |
Remove() : Boolean | public | . |
RemoveAt() : Void | public | . |
ToArray() : StarXData[] | public | . |
ToArrayOfString() : String[] | public | . |
ToString() : String | public | . |
ToString() : String | public | . |
StarPackException Class
Summary
public class StarPackException : Exception, System.Runtime.Serialization.ISerializable
StarPackException.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarPackException() | public | Initializes a new instance of the class. |
StarPackException() | public | |
Property Members
Method Members
StarPackWriter Class
Summary
public class StarPackWriter
A writer that provides a way to write StarPack objects to streams or files.
Constructor Members
Name | Access | Summary |
---|
StarPackWriter() | public | Creates a new StarPackWriter instance. |
StarPackWriter() | public | Creates a new StarPackWriter instance. |
StarPackWriter() | public | Creates a new StarPackWriter instance. |
Field Members
Name | Access | Summary |
---|
BlockIndent : Int32 | public | |
DefaultBlank : Char | public | |
Error_InvalidName : Int32 | public | |
Error_InvalidTag : Int32 | public | |
Error_InvalidValue : Int32 | public | |
Error_LoopNotIntegral : Int32 | public | |
ErrorCountLimit : Int32 | public | Maximum allowed number of errors, StarPackWriter will abort the Write process and throw a SPWException when this limit is exceeded. |
FrameIndent : Int32 | public | |
IndentChar : Char | public | |
LoopIndent : Int32 | public | |
NewLine : String | public | The newline string. |
Property Members
Name | Access | Summary |
---|
ErrorCount : Int32 | public | The error count. |
ErrorList : StarPWError[] | public | The error information list. |
Indent : Int32 | public | The current indentation level. |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | Closes the target writer. |
Flush() : Void | public | Flushs the target writer. |
SetTarget() : Void | public | Sets the target. |
SetTarget() : Void | public | Sets the target. |
Write() : Void | public | Writes a StarBlock. |
Write() : Void | public | Writes a StarPack. |
StarPWException Class
Summary
public class StarPWException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarPWException() | public | |
StarPWException() | public | |
Property Members
Name | Access | Summary |
---|
ErrorList : StarPWError[] | public | |
Method Members
StarPWError Class
Summary
public class StarPWError
.
Constructor Members
Name | Access | Summary |
---|
StarPWError() | public | |
StarPWError() | public | |
Field Members
Name | Access | Summary |
---|
EColumn : Int32 | public | |
ELine : Int32 | public | |
SColumn : Int32 | public | |
SLine : Int32 | public | |
Property Members
Name | Access | Summary |
---|
Code : Int32 | public | Error code. |
Column : Int32 | public | Column number, 1-based. |
Description : String | public | Error details. |
Line : Int32 | public | Line number, 1-based. |
Method Members
StarPackReader Class
Summary
public class StarPackReader
A reader that creates StarPack objects from the STAR streams or files.
Constructor Members
Name | Access | Summary |
---|
StarPackReader() | public | Creates a new StarPackReader instance. |
StarPackReader() | public | Creates a new StarPackReader instance. |
StarPackReader() | public | Creates a new StarPackReader instance. |
Field Members
Name | Access | Summary |
---|
ErrorCountLimit : Int32 | public | Maximum allowed number of errors, The StarPackReader instance will abort the Read process and throw a SPRException when this limit is exceeded. |
FatalErrorCodes : Int32[] | public | Error numbers representing fatal errors, The StarPackReader instance will abort the Read process and throw a SPRException when encountering these error codes. |
NewLine : String | public | . |
NormalizeNewLines : Boolean | public | . |
Property Members
Name | Access | Summary |
---|
ErrorCount : Int32 | public | Count of errors, non-zero if there are syntactic/semantic errors. |
ErrorList : StarPRError[] | public | A detailed error information list. |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | Closes the reader instance and the underlying source stream. |
Read() : StarPack | public | Reads a StarPack object from the source. |
Read() : StarPack | public | Reads a StarPack object from the source. |
SetSource() : Void | public | Sets the source stream. |
SetSource() : Void | public | Sets the source stream. |
SetSourceText() : Void | public | Sets the source text. |
StarPRException Class
Summary
public class StarPRException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
StarPRException() | public | |
StarPRException() | public | |
Property Members
Name | Access | Summary |
---|
ErrorList : StarPRError[] | public | . |
Method Members
StarPRError Class
Summary
public class StarPRError
.
Constructor Members
Name | Access | Summary |
---|
StarPRError() | public | |
StarPRError() | public | |
Field Members
Name | Access | Summary |
---|
EColumn : Int32 | public | |
ELine : Int32 | public | |
SColumn : Int32 | public | |
SLine : Int32 | public | |
Property Members
Name | Access | Summary |
---|
Code : Int32 | public | Error code. |
Column : Int32 | public | Column number. |
Description : String | public | Error details. |
Line : Int32 | public | Line number. |
Method Members
Namespace : AStar.Cif
AStar.Cif Type List
Interfaces
Enumerations
Type | Summary |
---|
CifContentType | . |
CifDMergingMode | . |
CifFieldType | The type of a field, primitive or loop. |
CifPRErrorCode | . |
CifPWErrorCode | . |
CifTextReadState | . |
CifTextWriteState | . |
CifValidationCode | The message IDs or error codes for CIF validation against DDL1/DDL2 dictionaries. |
CifValueLiteral | A enum of the literal forms of CIF values. A CIF value literal is the representation of a CIF value within the source file: the non-quoted (NQ), single-quoted (SQ), double-quoted (DQ) and semi-colon (SC) delimited forms. The reading process may optionally mark the original literal form of a CifValue, in the literal field; and the writing process may write CIF file according to the prefered literal, specified by the Literal field. |
Classes
Type | Summary |
---|
CifBlock | A CIF data block. |
CifDCategory | . |
CifDField | . |
CifDictionary | CifDictionary. |
CifDictionaryException | . |
CifDRange | . |
CifDRelatedField | . |
CifDType | . |
CifField | The abstract base class of CifPrimitiveField and CifLoopField. |
CifFieldCollection | A collection of CifField objects. |
CifFrame | A CIF save-frame object. |
CifFrameCollection | A collection of CifFrame objects. |
CifLoop | A collection of CifLoopField objects, grouping the looped fields in the CifFieldCollection object, represents a CIF loop structure in the source. |
CifLoopField | A CIF loop field. The 1-dimensional (.Level == 1) data container holding a CifValueList, which is a list of CifValue instances. |
CifLoopRow | . |
CifPack | The top-level collection of CIF data objects, a packing of data blocks in a CIF file. |
CifPackException | CifPackException. |
CifPackReader | A reader that creates CifPack objects from the CIF streams or files. |
CifPackWriter | A writer that provides a way to write CifPack objects to streams or files. |
CifPRError | . |
CifPRException | . |
CifPrimitiveField | The primitive field, represents a tag - value pair in the source. The 0-dimensional (.Level == 0) data container holding a single CifValue. |
CifPWError | . |
CifPWException | . |
CifTextReader | CifTextReader: A reader that provides fast, non-cached, forward-only access to CIF data. Duplication of names or fields is not checked. |
CifTextWriter | CifTextWriter: A writer that provides a fast, non-cached, forward-only way to write valid CIF streams or files. Duplication of names or fields is not checked. |
CifTRException | . |
CifTWException | . |
CifValidationConsoleWriter | . |
CifValidationError | . |
CifValidationResult | . |
CifValidationResultBuilder | . |
CifValidationResultHtmlWriter | . |
CifValidationResultTextWriter | . |
CifValue | CifValue, the premitive data type of a CIF file, is present in a CifPrimitiveField or a CifValueList. |
CifValueList | CifValueList. |
CifXData | The base class of CifValue and CifValueList. |
AStar.Cif Interfaces
ICifValidationHandler Interface
Summary
public interface ICifValidationHandler
.
Property Members
Name | Access | Summary |
---|
IsValid : Boolean | public | |
Method Members
Name | Access | Summary |
---|
OnError() : Void | public | |
OnMessage() : Void | public | |
AStar.Cif Enumerations
CifFieldType Enumeration
Summary
public enumeration CifFieldType
The type of a field, primitive or loop.
Enumeration Members
Field | Summary |
---|
Loop | A loop(ed) field. |
Primitive | A primitive field. |
CifValueLiteral Enumeration
Summary
public enumeration CifValueLiteral
A enum of the literal forms of CIF values. A CIF value literal is the representation of a CIF value within the source file: the non-quoted (NQ), single-quoted (SQ), double-quoted (DQ) and semi-colon (SC) delimited forms. The reading process may optionally mark the original literal form of a CifValue, in the literal field; and the writing process may write CIF file according to the prefered literal, specified by the Literal field.
Enumeration Members
CifDMergingMode Enumeration
Summary
public enumeration CifDMergingMode
.
Enumeration Members
Field | Summary |
---|
Overlay | |
Replace | |
Strict | |
CifValidationCode Enumeration
Summary
public enumeration CifValidationCode
The message IDs or error codes for CIF validation against DDL1/DDL2 dictionaries.
Enumeration Members
Field | Summary |
---|
Block | |
BlockEnd | |
DataLevelInvalid | The data level is invalid, DDL1 only. |
FieldsConflicting | . |
Frame | |
FrameEnd | |
LoopInconsistent | All of the fields in the current loop are not defined in the same category. (All of the fields in a loop must be defined in the same category.) |
Message | |
MissingDependency | A field on which the current field depends does not present. |
MissingKey | The key field of the loop (category) does not present. Defined in the category frames of a DDL2 dictionary as '_category_key.name'. |
MissingMandatory | The mandatory field of the loop (category) does not present. |
MissingParent | The parent field does not present. |
MissingReference | The referenced field does not present. For a DDL1 dictionary, field(s) in '_list_reference'. |
Pack | |
PackEnd | |
SUNotAllowed | A su presents but it's not allowed by the definition. |
Undefined | The definition does not present in the dictionary. |
ValueInvalidAsChild | A value of a child value list is not in the parent value list. |
ValueInvalidAsKey | A value or combination of values does not form an unique key. Defined in the category frames of a DDL2 dictionary as '_category_key.name'. For a DDL1 dictionary, field(s) in '_list_reference' and '_list_uniqueness' of an item definition. |
ValueOutOfEnum | A value is out of the enumeration. |
ValueOutOfRange | A value is out of the range. |
ValueTypeInvalid | The value type is invalid. |
CifPWErrorCode Enumeration
Summary
public enumeration CifPWErrorCode
.
Enumeration Members
Field | Summary |
---|
ColumnLimit | |
InvalidName | |
InvalidTag | |
InvalidValue | |
LoopNotIntegral | |
NameLimit | |
CifPRErrorCode Enumeration
Summary
public enumeration CifPRErrorCode
.
Enumeration Members
Field | Summary |
---|
ColumnLimit | |
DuplicateBlockName | |
DuplicateFieldName | |
DuplicateFrameName | |
GlobalBlock | |
InvalidChar | |
LoopNotIntegral | |
MissingQuote | |
NameLimit | |
SaveFrameRef | |
UnexpectedInBlock | |
UnexpectedInFrame | |
UnexpectedInTop | |
CifContentType Enumeration
Summary
public enumeration CifContentType
.
Enumeration Members
Field | Summary |
---|
Block | |
Comment | |
EndBlock | |
EndFrame | |
EndLoop | |
Field | |
Frame | |
Loop | |
None | |
CifTextReadState Enumeration
Summary
public enumeration CifTextReadState
.
Enumeration Members
Field | Summary |
---|
Closed | |
EndOfFile | |
Error | |
Initial | |
Interactive | |
CifTextWriteState Enumeration
Summary
public enumeration CifTextWriteState
.
Enumeration Members
Field | Summary |
---|
Block | |
Closed | |
Frame | |
Initial | |
Loop | |
AStar.Cif Classes
CifPack Class
Summary
public class CifPack : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
The top-level collection of CIF data objects, a packing of data blocks in a CIF file.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifPack() | public | Creates an empty CifPack instance. |
CifPack() | public | Creates a new CifPack instance from the CIF file. |
Field Members
Name | Access | Summary |
---|
km : CifBlock} | protected | (from AStar.Common.NamedItemCollection`1) |
vs : CifBlock} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : CifBlock | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : CifBlock | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Common.NamedItemCollection`1) |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Common.NamedItemCollection`1) Clears all items in the collection. |
Clone() : CifPack | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
Get() : CifBlock | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetEnumerator() : CifBlock} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Common.NamedItemCollection`1) |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Load() : Void | public | . |
Load() : Void | public | . |
Load() : Void | public | Loads data from a CIF file. |
Load() : Void | public | Loads data from a CIF file. |
Merge() : Void | public | . |
Merge() : Void | public | . |
Merge() : CifPack | public | . |
Parse() : Void | public | Parses the CIF source string. |
Parse() : Void | public | . |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection. |
RemoveAt() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item at the index. |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
Save() : Void | public | . |
Save() : Void | public | . |
Save() : Void | public | Saves the data to a CIF file. |
Save() : Void | public | . |
Split() : CifPack[] | public | . |
Split() : CifPack[] | public | . |
ToArray() : CifBlock[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
ToText() : String | public | Returns a CIF source string which represents the data in the CifPack object. |
ToText() : String | public | . |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
CifFieldCollection Class
Summary
public abstract class CifFieldCollection : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable, AStar.Common.INamed
A collection of CifField objects.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifFieldCollection() | protected | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
comment : String | familyOrAssembly | |
km : CifField} | protected | (from AStar.Common.NamedItemCollection`1) |
name : String | familyOrAssembly | |
vs : CifField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Loops : CifLoop} | public | . |
Name : String | public | The name of the collection, used as the identifier of a CifFrame or CifBlock instance. |
Primitives : CifPrimitiveField} | public | . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | This method overrides the base class's definition, to prevent adding a loop field. |
Add() : Void | public | Adds a data loop to the collection. |
Add() : Void | public | Adds a primitive field to the collection. |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
Contains() : Boolean | public | . |
Contains() : Boolean | public | . |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : Void | public | Creates a primitive field in the collection. |
Get() : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetData() : CifXData | public | . |
GetData() : CifXData | public | . |
GetEnumerator() : CifField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetLevel() : Int32 | public | . |
GetList() : CifValueList | public | . |
GetList() : CifValueList | public | . |
GetList() : CifValueList | public | . |
GetList() : CifValueList | public | . |
GetLoop() : CifLoop | public | Gets the loop which contains a field with the name. |
GetLoop() : CifLoop | public | Gets the loop which contains fields with the name and names. |
GetValue() : CifValue | public | . |
GetValue() : CifValue | public | . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | This method overrides the base class's definition, to prevent inserting a loop field. |
Insert() : Void | public | Inserts a data loop to the collection. |
Insert() : Void | public | . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | . |
Query() : Boolean | public | |
Query() : Boolean | public | |
Query() : Boolean | public | |
Remove() : Boolean | public | . |
Remove() : Boolean | public | . |
RemoveAt() : Boolean | public | . |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
SetData() : CifXData | public | . |
SetList() : CifValueList | public | . |
SetValue() : CifValue | public | . |
ToArray() : CifField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
CifBlock Class
Summary
public class CifBlock : CifFieldCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable, AStar.Common.INamed
A CIF data block.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifBlock() | public | Creates a new CifBlock instance, (for a global_ block). Note 'global_' is not allowed in the formal CIF specification. |
CifBlock() | public | Creates a new CifBlock instance. |
CifBlock() | public | . |
Field Members
Name | Access | Summary |
---|
comment : String | familyOrAssembly | (from AStar.Cif.CifFieldCollection) |
Frames : CifFrameCollection | public | . |
km : CifField} | protected | (from AStar.Common.NamedItemCollection`1) |
name : String | familyOrAssembly | (from AStar.Cif.CifFieldCollection) |
vs : CifField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | (from AStar.Cif.CifFieldCollection) . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Loops : CifLoop} | public | (from AStar.Cif.CifFieldCollection) . |
Name : String | public | (from AStar.Cif.CifFieldCollection) The name of the collection, used as the identifier of a CifFrame or CifBlock instance. |
Primitives : CifPrimitiveField} | public | (from AStar.Cif.CifFieldCollection) . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent adding a loop field. |
Add() : Void | public | (from AStar.Cif.CifFieldCollection) Adds a data loop to the collection. |
Add() : Void | public | (from AStar.Cif.CifFieldCollection) Adds a primitive field to the collection. |
AddFrame() : Void | public | eq. to .Frames.Add(frame). |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Cif.CifFieldCollection) . |
Clone() : CifBlock | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
Contains() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
Contains() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
ContainsFrame() : Boolean | public | eq. to .Frames.Contains(name). |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : Void | public | (from AStar.Cif.CifFieldCollection) Creates a primitive field in the collection. |
Get() : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetData() : CifXData | public | (from AStar.Cif.CifFieldCollection) . |
GetData() : CifXData | public | (from AStar.Cif.CifFieldCollection) . |
GetEnumerator() : CifField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetFrame() : CifFrame | public | eq. to .Frames[name]. |
GetLevel() : Int32 | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetLoop() : CifLoop | public | (from AStar.Cif.CifFieldCollection) Gets the loop which contains a field with the name. |
GetLoop() : CifLoop | public | (from AStar.Cif.CifFieldCollection) Gets the loop which contains fields with the name and names. |
GetValue() : CifValue | public | (from AStar.Cif.CifFieldCollection) . |
GetValue() : CifValue | public | (from AStar.Cif.CifFieldCollection) . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field. |
Insert() : Void | public | (from AStar.Cif.CifFieldCollection) Inserts a data loop to the collection. |
Insert() : Void | public | (from AStar.Cif.CifFieldCollection) . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | . |
Merge() : Void | public | . |
Merge() : Void | public | (from AStar.Cif.CifFieldCollection) . |
Query() : Boolean | public | (from AStar.Cif.CifFieldCollection) |
Query() : Boolean | public | (from AStar.Cif.CifFieldCollection) |
Query() : Boolean | public | (from AStar.Cif.CifFieldCollection) |
Remove() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
Remove() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
RemoveAt() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
RemoveFrame() : Boolean | public | . |
RemoveFrame() : Boolean | public | eq. to .Frames.Remove(name). |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
SetData() : CifXData | public | (from AStar.Cif.CifFieldCollection) . |
SetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
SetValue() : CifValue | public | (from AStar.Cif.CifFieldCollection) . |
ToArray() : CifField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
CifFrameCollection Class
Summary
public class CifFrameCollection : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
A collection of CifFrame objects.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifFrameCollection() | public | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
km : CifFrame} | protected | (from AStar.Common.NamedItemCollection`1) |
vs : CifFrame} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : CifFrame | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : CifFrame | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Common.NamedItemCollection`1) |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Common.NamedItemCollection`1) Clears all items in the collection. |
Clone() : CifFrameCollection | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
Get() : CifFrame | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetEnumerator() : CifFrame} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Common.NamedItemCollection`1) |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | . |
Merge() : Void | public | . |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Remove() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection. |
RemoveAt() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Removes the item at the index. |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
ToArray() : CifFrame[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
CifFrame Class
Summary
public class CifFrame : CifFieldCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable, AStar.Common.INamed
A CIF save-frame object.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifFrame() | public | Creates a new CifFrame instance. |
CifFrame() | public | . |
Field Members
Name | Access | Summary |
---|
comment : String | familyOrAssembly | (from AStar.Cif.CifFieldCollection) |
km : CifField} | protected | (from AStar.Common.NamedItemCollection`1) |
name : String | familyOrAssembly | (from AStar.Cif.CifFieldCollection) |
vs : CifField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
Comment : String | public | (from AStar.Cif.CifFieldCollection) . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection. |
Item : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name. |
Loops : CifLoop} | public | (from AStar.Cif.CifFieldCollection) . |
Name : String | public | (from AStar.Cif.CifFieldCollection) The name of the collection, used as the identifier of a CifFrame or CifBlock instance. |
Primitives : CifPrimitiveField} | public | (from AStar.Cif.CifFieldCollection) . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | (from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent adding a loop field. |
Add() : Void | public | (from AStar.Cif.CifFieldCollection) Adds a data loop to the collection. |
Add() : Void | public | (from AStar.Cif.CifFieldCollection) Adds a primitive field to the collection. |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Clear() : Void | public | (from AStar.Cif.CifFieldCollection) . |
Clone() : CifFrame | public | . |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
Contains() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
Contains() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : Void | public | (from AStar.Cif.CifFieldCollection) Creates a primitive field in the collection. |
Get() : CifField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetData() : CifXData | public | (from AStar.Cif.CifFieldCollection) . |
GetData() : CifXData | public | (from AStar.Cif.CifFieldCollection) . |
GetEnumerator() : CifField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetLevel() : Int32 | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
GetLoop() : CifLoop | public | (from AStar.Cif.CifFieldCollection) Gets the loop which contains a field with the name. |
GetLoop() : CifLoop | public | (from AStar.Cif.CifFieldCollection) Gets the loop which contains fields with the name and names. |
GetValue() : CifValue | public | (from AStar.Cif.CifFieldCollection) . |
GetValue() : CifValue | public | (from AStar.Cif.CifFieldCollection) . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | (from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field. |
Insert() : Void | public | (from AStar.Cif.CifFieldCollection) Inserts a data loop to the collection. |
Insert() : Void | public | (from AStar.Cif.CifFieldCollection) . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
Merge() : Void | public | (from AStar.Cif.CifFieldCollection) . |
Query() : Boolean | public | (from AStar.Cif.CifFieldCollection) |
Query() : Boolean | public | (from AStar.Cif.CifFieldCollection) |
Query() : Boolean | public | (from AStar.Cif.CifFieldCollection) |
Remove() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
Remove() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
RemoveAt() : Boolean | public | (from AStar.Cif.CifFieldCollection) . |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
SetData() : CifXData | public | (from AStar.Cif.CifFieldCollection) . |
SetList() : CifValueList | public | (from AStar.Cif.CifFieldCollection) . |
SetValue() : CifValue | public | (from AStar.Cif.CifFieldCollection) . |
ToArray() : CifField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
CifField Class
Summary
public abstract class CifField : AStar.Common.INamed
The abstract base class of CifPrimitiveField and CifLoopField.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifField() | protected | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
name : String | familyOrAssembly | |
Property Members
Name | Access | Summary |
---|
Data : CifXData | public | |
Level : Int32 | public | |
List : CifValueList | public | |
Name : String | public | . |
Type : CifFieldType | public | |
Value : CifValue | public | |
Method Members
CifPrimitiveField Class
Summary
public class CifPrimitiveField : CifField, AStar.Common.INamed
The primitive field, represents a tag - value pair in the source. The 0-dimensional (.Level == 0) data container holding a single CifValue.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifPrimitiveField() | public | Creates a CifPrimitiveField instance with the 'name' and CifValue.Unknown (?). |
CifPrimitiveField() | public | Creates a CifPrimitiveField instance with the 'name' and 'val'. |
Field Members
Name | Access | Summary |
---|
name : String | familyOrAssembly | (from AStar.Cif.CifField) |
Property Members
Name | Access | Summary |
---|
Data : CifXData | public | The associated field data. |
Level : Int32 | public | Returns 0. |
List : CifValueList | public | The associated field data (CifValueList), always null. |
Name : String | public | (from AStar.Cif.CifField) . |
Type : CifFieldType | public | Returns CifFieldType.Primitive. |
Value : CifValue | public | The associated field data (CifValue). |
Method Members
Name | Access | Summary |
---|
Clone() : CifPrimitiveField | public | . |
CifLoop Class
Summary
public class CifLoop : NamedItemCollection, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
A collection of CifLoopField objects, grouping the looped fields in the CifFieldCollection object, represents a CIF loop structure in the source.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifLoop() | public | Creates an empty CifLoop instance, it's not integral until the first field added and the first row filled in. Note the CifLoop instance is not integral if it contains no fields and data, or it's data is not aligned. |
CifLoop() | public | . |
CifLoop() | public | . |
CifLoop() | public | . |
Field Members
Name | Access | Summary |
---|
km : CifLoopField} | protected | (from AStar.Common.NamedItemCollection`1) |
vs : CifLoopField} | protected | (from AStar.Common.NamedItemCollection`1) |
Property Members
Name | Access | Summary |
---|
Capacity : Int32 | public | (from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing. |
ColumnCount : Int32 | public | . |
Count : Int32 | public | (from AStar.Common.NamedItemCollection`1) The number of items in the collection. |
IsIntegral : Boolean | public | Indicates whether the loop structure is integral. |
IsReadOnly : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Item : CifValue | public | Gets/Sets a value at the specified row and column indexes. |
Item : CifValue | public | Gets/Sets a value specified by the row index and field name. |
RowCount : Int32 | public | . |
Rows : CifLoopRow} | public | . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | . |
AddRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
AddRow() : CifLoopRow | public | . |
CheckIntegrity() : Boolean | public | Checks the integrity of the CifLoop. 1) There is at least one CifLoopField in the CifLoop; 2) All those CifLoopFields contain the same Count of values (RowCount); 3) There is at least one row in the CifLoop. |
Clear() : Void | public | . |
ClearData() : Void | public | . |
Clone() : CifLoop | public | Note the Fill state is not cloned. |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
Contains() : Boolean | public | (from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name. |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CopyTo() : Void | public | (from AStar.Common.NamedItemCollection`1) |
CreateField() : CifLoopField | public | . |
CreateFields() : Void | public | . |
Fill() : Boolean | public | . |
Get() : CifLoopField | public | (from AStar.Common.NamedItemCollection`1) Gets the item with the specified name. |
GetEnumerator() : CifLoopField} | public | (from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator. |
GetRow() : CifLoopRow | public | . |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) |
IndexOf() : Int32 | public | (from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name. |
Insert() : Void | public | . |
InsertRange() : Void | protected | (from AStar.Common.NamedItemCollection`1) |
InsertRow() : CifLoopRow | public | . |
Remove() : Boolean | public | . |
Remove() : Boolean | public | . |
RemoveAt() : Boolean | public | . |
RemoveRange() : Boolean | protected | (from AStar.Common.NamedItemCollection`1) . |
RemoveRowAt() : Boolean | public | . |
ToArray() : CifLoopField[] | public | (from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array. |
TryGet() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
TryGetR() : Boolean | public | (from AStar.Common.NamedItemCollection`1) |
CifLoopField Class
Summary
public class CifLoopField : CifField, AStar.Common.INamed
A CIF loop field. The 1-dimensional (.Level == 1) data container holding a CifValueList, which is a list of CifValue instances.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifLoopField() | public | . |
Field Members
Name | Access | Summary |
---|
name : String | familyOrAssembly | (from AStar.Cif.CifField) |
Property Members
Name | Access | Summary |
---|
Data : CifXData | public | . |
Level : Int32 | public | The level of the field, always returns 1. |
List : CifValueList | public | . |
Loop : CifLoop | public | The CifLoop instance which contains the CifLoopField instance. |
Name : String | public | (from AStar.Cif.CifField) . |
Type : CifFieldType | public | The type of the field, always returns CifFieldType.Loop. |
Value : CifValue | public | . |
Method Members
Name | Access | Summary |
---|
Clone() : CifLoopField | public | . |
CifLoopRow Class
Summary
public class CifLoopRow
.
Property Members
Name | Access | Summary |
---|
Count : Int32 | public | . |
Item : CifValue | public | . |
Item : CifValue | public | . |
Loop : CifLoop | public | . |
Position : Int32 | public | . |
Method Members
Name | Access | Summary |
---|
Contains() : Boolean | public | . |
CifXData Class
Summary
public abstract class CifXData
The base class of CifValue and CifValueList.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifXData() | protected | Initializes a new instance of the class. |
Property Members
Name | Access | Summary |
---|
Level : Int32 | public | . |
Method Members
Name | Access | Summary |
---|
AsList() : CifValueList | public | . |
AsValue() : CifValue | public | . |
CifValue Class
Summary
public class CifValue : CifXData, System.IEquatable, System.IComparable
CifValue, the premitive data type of a CIF file, is present in a CifPrimitiveField or a CifValueList.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifValue() | public | Initializes a new instance of CifValue from the instance of Measurand. |
CifValue() | public | Initializes a new instance of CifValue from the double. |
CifValue() | public | Initializes a new instance of CifValue from the (Int32) integer. |
CifValue() | public | Initializes a new instance of CifValue from the (Int64) integer. |
CifValue() | public | Initializes a new instance of CifValue from the string. |
CifValue() | public | Initializes a new instance of CifValue from the string. |
Field Members
Name | Access | Summary |
---|
Default : CifValue | public | (.). |
Unknown : CifValue | public | (?). |
Property Members
Name | Access | Summary |
---|
Level : Int32 | public | . |
Literal : CifValueLiteral | public | Marks the original or prefered literal form of the CifValue instance. |
Method Members
Name | Access | Summary |
---|
AsList() : CifValueList | public | . |
AsValue() : CifValue | public | . |
Clone() : CifValue | public | . |
CompareTo() : Int32 | public | . |
Equals() : Boolean | public | . |
Equals() : Boolean | public | . |
GetHashCode() : Int32 | public | . |
IsDefault() : Boolean | public | . |
IsUnknown() : Boolean | public | . |
ToInt32() : Int32 | public | Converts the CifValue instance to an (Int32) integer. |
ToInt64() : Int64 | public | Converts the CifValue instance to an (Int64) integer. |
ToLower() : CifValue | public | . |
ToMeasurand() : Measurand | public | Converts the CifValue instance to a Measurand instance. |
ToNumber() : Double | public | Converts the CifValue instance to a number (double). |
ToString() : String | public | Converts the CifValue instance to a string. |
ToUpper() : CifValue | public | . |
CifValueList Class
Summary
public class CifValueList : CifXData, System.Collections.Generic.IList, System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable
CifValueList.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifValueList() | public | . |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
CifValueList() | public | |
Property Members
Name | Access | Summary |
---|
Count : Int32 | public | . |
IsReadOnly : Boolean | public | . |
Item : CifValue | public | . |
Level : Int32 | public | . |
Method Members
Name | Access | Summary |
---|
Add() : Void | public | . |
AsList() : CifValueList | public | . |
AsValue() : CifValue | public | . |
Clear() : Void | public | . |
Clone() : CifValueList | public | . |
Contains() : Boolean | public | . |
CopyTo() : Void | public | . |
CopyTo() : Void | public | . |
GetEnumerator() : CifValue} | public | . |
IndexOf() : Int32 | public | . |
Insert() : Void | public | . |
Remove() : Boolean | public | . |
RemoveAt() : Void | public | . |
ToArray() : CifValue[] | public | . |
ToArrayOfString() : String[] | public | . |
ToString() : String | public | . |
ToString() : String | public | . |
CifPackException Class
Summary
public class CifPackException : Exception, System.Runtime.Serialization.ISerializable
CifPackException.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifPackException() | public | Initializes a new instance of the class. |
CifPackException() | public | |
Property Members
Method Members
CifDictionary Class
Summary
public class CifDictionary
CifDictionary.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifDictionary() | public | . |
CifDictionary() | public | . |
Property Members
Name | Access | Summary |
---|
MergingMode : CifDMergingMode | public | |
Name : String | public | |
Specification : String | public | |
Version : String | public | |
Method Members
Name | Access | Summary |
---|
Clear() : Void | public | . |
Load() : Void | public | . |
Load() : Void | public | . |
Load() : Void | public | . |
LoadDDL1() : Void | public | . |
LoadDDL2() : Void | public | . |
Validate() : Boolean | public | . |
Validate() : Boolean | public | . |
Validate() : Boolean | public | . |
Validate() : Boolean | public | . |
Validate() : Boolean | public | . |
CifDField Class
Summary
public class CifDField
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifDField() | public | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
Aliases : String} | public | |
Category : String | public | |
DependentFields : String} | public | |
Description : String | public | |
DictionaryIndex : Int32 | public | |
EnumerationValues : CifValueList | public | |
IsMandatory : Boolean | public | |
Level : Int32 | public | |
ListReferencedFields : String} | public | |
ListUniquenessFields : String} | public | |
Name : String | public | |
RangeMaxValues : CifValueList | public | |
RangeMinValues : CifValueList | public | |
RelatedFunctions : String} | public | |
RelatedNames : String} | public | |
Type : String | public | |
TypeConditions : String} | public | |
WithSu : Boolean | public | |
Method Members
Name | Access | Summary |
---|
Clone() : CifDField | public | |
CifDRange Class
Summary
public class CifDRange
.
Constructor Members
Name | Access | Summary |
---|
CifDRange() | public | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
Max : CifValue | public | |
Min : CifValue | public | |
Method Members
CifDRelatedField Class
Summary
public class CifDRelatedField
.
Constructor Members
Field Members
Method Members
CifDType Class
Summary
public class CifDType
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifDType() | public | |
CifDType() | public | |
Field Members
Name | Access | Summary |
---|
Construct : String | public | |
DictionaryIndex : Int32 | public | |
Name : String | public | |
Primitive : String | public | |
Method Members
Name | Access | Summary |
---|
GetRegex() : Regex | public | |
Test() : Boolean | public | |
CifDCategory Class
Summary
public class CifDCategory
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifDCategory() | public | Initializes a new instance of the class. |
Field Members
Name | Access | Summary |
---|
Description : String | public | |
DictionaryIndex : Int32 | public | |
Keys : String} | public | |
MandatoryFields : String} | public | |
Name : String | public | |
Method Members
CifValidationResultBuilder Class
Summary
public class CifValidationResultBuilder : AStar.Cif.ICifValidationHandler
.
Constructor Members
Name | Access | Summary |
---|
CifValidationResultBuilder() | public | Initializes a new instance of the class. |
Property Members
Name | Access | Summary |
---|
IsValid : Boolean | public | |
Method Members
Name | Access | Summary |
---|
GetResult() : CifValidationResult | public | |
OnError() : Void | public | |
OnMessage() : Void | public | |
CifValidationResult Class
Summary
public class CifValidationResult
.
Constructor Members
Name | Access | Summary |
---|
CifValidationResult() | public | |
Property Members
Name | Access | Summary |
---|
ErrorCount : Int32 | public | |
ErrorList : CifValidationError[] | public | |
Name : String | public | |
SectionCount : Int32 | public | |
SectionList : CifValidationResult[] | public | |
TotalErrorCount : Int32 | public | |
Type : String | public | |
Method Members
Name | Access | Summary |
---|
AddError() : Void | public | |
AddSection() : Void | public | |
CifValidationResultTextWriter Class
Summary
public class CifValidationResultTextWriter
.
Constructor Members
Name | Access | Summary |
---|
CifValidationResultTextWriter() | public | Initializes a new instance of the class. |
CifValidationResultTextWriter() | public | |
CifValidationResultTextWriter() | public | |
CifValidationResultTextWriter() | public | |
Property Members
Name | Access | Summary |
---|
Target : TextWriter | public | |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | |
Flush() : Void | public | |
Write() : Void | public | |
Write() : Void | public | |
CifValidationResultHtmlWriter Class
Summary
public class CifValidationResultHtmlWriter
.
Constructor Members
Name | Access | Summary |
---|
CifValidationResultHtmlWriter() | public | Initializes a new instance of the class. |
CifValidationResultHtmlWriter() | public | |
CifValidationResultHtmlWriter() | public | |
CifValidationResultHtmlWriter() | public | |
Property Members
Name | Access | Summary |
---|
Target : TextWriter | public | |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | |
Flush() : Void | public | |
Write() : Void | public | |
Write() : Void | public | |
CifValidationConsoleWriter Class
Summary
public class CifValidationConsoleWriter : AStar.Cif.ICifValidationHandler
.
Constructor Members
Name | Access | Summary |
---|
CifValidationConsoleWriter() | public | Initializes a new instance of the class. |
Property Members
Name | Access | Summary |
---|
ColorForError : ConsoleColor | public | . |
ColorForMessage : ConsoleColor | public | . |
IsValid : Boolean | public | |
UseColors : Boolean | public | . |
Method Members
Name | Access | Summary |
---|
OnError() : Void | public | |
OnMessage() : Void | public | |
CifValidationError Class
Summary
public class CifValidationError
.
Constructor Members
Name | Access | Summary |
---|
CifValidationError() | public | |
CifValidationError() | public | |
Property Members
Name | Access | Summary |
---|
Arguments : Object[] | public | |
Code : Int32 | public | |
Description : String | public | |
Method Members
CifDictionaryException Class
Summary
public class CifDictionaryException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifDictionaryException() | public | Initializes a new instance of the class. |
CifDictionaryException() | public | |
Property Members
Method Members
CifPackWriter Class
Summary
public class CifPackWriter
A writer that provides a way to write CifPack objects to streams or files.
Constructor Members
Name | Access | Summary |
---|
CifPackWriter() | public | Creates a new CifPackWriter instance. |
CifPackWriter() | public | Creates a new CifPackWriter instance. |
CifPackWriter() | public | Creates a new CifPackWriter instance. |
Field Members
Name | Access | Summary |
---|
BlockIndent : Int32 | public | |
ColumnLimit : Int32 | public | . |
DefaultBlank : Char | public | |
Error_ColumnLimit : Int32 | public | |
Error_InvalidName : Int32 | public | |
Error_InvalidTag : Int32 | public | |
Error_InvalidValue : Int32 | public | |
Error_LoopNotIntegral : Int32 | public | |
Error_NameLimit : Int32 | public | |
ErrorCountLimit : Int32 | public | Maximum allowed number of errors, CifPackWriter will abort the Write process and throw a CPWException when this limit is exceeded. |
FrameIndent : Int32 | public | |
IndentChar : Char | public | |
LoopIndent : Int32 | public | |
NameLimit : Int32 | public | . |
NewLine : String | public | The newline string. |
Property Members
Name | Access | Summary |
---|
ErrorCount : Int32 | public | The error count. |
ErrorList : CifPWError[] | public | The error information list. |
Indent : Int32 | public | The current indentation level. |
Method Members
Name | Access | Summary |
---|
BslEolEscape() : String | public | |
BslEolEscapeLine() : String | public | |
BslEolUnescape() : String | public | |
Close() : Void | public | Closes the target writer. |
Flush() : Void | public | Flushs the target writer. |
SetTarget() : Void | public | Sets the target. |
SetTarget() : Void | public | Sets the target. |
Write() : Void | public | Writes a CifBlock. |
Write() : Void | public | Writes a CifPack. |
CifPWException Class
Summary
public class CifPWException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifPWException() | public | |
CifPWException() | public | |
Property Members
Name | Access | Summary |
---|
ErrorList : CifPWError[] | public | |
Method Members
CifPWError Class
Summary
public class CifPWError
.
Constructor Members
Name | Access | Summary |
---|
CifPWError() | public | |
CifPWError() | public | |
Field Members
Name | Access | Summary |
---|
EColumn : Int32 | public | |
ELine : Int32 | public | |
SColumn : Int32 | public | |
SLine : Int32 | public | |
Property Members
Name | Access | Summary |
---|
Code : Int32 | public | Error code. |
Column : Int32 | public | Column number, 1-based. |
Description : String | public | Error details. |
Line : Int32 | public | Line number, 1-based. |
Method Members
CifPackReader Class
Summary
public class CifPackReader
A reader that creates CifPack objects from the CIF streams or files.
Constructor Members
Name | Access | Summary |
---|
CifPackReader() | public | Creates a new CifPackReader instance. |
CifPackReader() | public | Creates a new CifPackReader instance. |
CifPackReader() | public | Creates a new CifPackReader instance. |
Field Members
Name | Access | Summary |
---|
ColumnLimit : Int32 | public | . |
ErrorCountLimit : Int32 | public | Maximum allowed number of errors, The CifPackReader instance will abort the Read process and throw a CPRException when this limit is exceeded. |
FatalErrorCodes : Int32[] | public | Error numbers representing fatal errors, The CifPackReader instance will abort the Read process and throw a CPRException when encountering these error codes. |
NameLimit : Int32 | public | . |
NewLine : String | public | . |
NormalizeNewLines : Boolean | public | . |
Property Members
Name | Access | Summary |
---|
ErrorCount : Int32 | public | Count of errors, non-zero if there are syntactic/semantic errors. |
ErrorList : CifPRError[] | public | A detailed error information list. |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | Closes the reader instance and the underlying source stream. |
Read() : CifPack | public | Reads a CifPack object from the source. |
Read() : CifPack | public | Reads a CifPack object from the source. |
SetSource() : Void | public | Sets the source stream. |
SetSource() : Void | public | Sets the source stream. |
SetSourceText() : Void | public | Sets the source text. |
CifPRException Class
Summary
public class CifPRException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifPRException() | public | |
CifPRException() | public | |
Property Members
Name | Access | Summary |
---|
ErrorList : CifPRError[] | public | . |
Method Members
CifPRError Class
Summary
public class CifPRError
.
Constructor Members
Name | Access | Summary |
---|
CifPRError() | public | |
CifPRError() | public | |
Field Members
Name | Access | Summary |
---|
EColumn : Int32 | public | |
ELine : Int32 | public | |
SColumn : Int32 | public | |
SLine : Int32 | public | |
Property Members
Name | Access | Summary |
---|
Code : Int32 | public | Error code. |
Column : Int32 | public | Column number. |
Description : String | public | Error details. |
Line : Int32 | public | Line number. |
Method Members
CifTextReader Class
Summary
public class CifTextReader
CifTextReader: A reader that provides fast, non-cached, forward-only access to CIF data. Duplication of names or fields is not checked.
Constructor Members
Name | Access | Summary |
---|
CifTextReader() | public | Creates a new CifTextReader instance. The reader is in a closed state, until the source is set by calling the SetSource or SetSourceText method. |
CifTextReader() | public | Creates a new CifTextReader instance. |
CifTextReader() | public | Creates a new CifTextReader instance. |
Field Members
Name | Access | Summary |
---|
ColumnLimit : Int32 | public | . |
IgnoreScannerErrors : Boolean | public | . |
NameLimit : Int32 | public | . |
NewLine : String | public | . |
NormalizeNewLines : Boolean | public | . |
Property Members
Name | Access | Summary |
---|
Column : Int32 | public | The current column number. |
ContentType : CifContentType | public | The type of the data in the reader. |
EOF : Boolean | public | Indicates whether the reader is at the end of the source (file). |
Line : Int32 | public | The current line number. |
Name : String | public | The name of the current primitive field / loop field / block / frame. |
Names : String[] | public | The field names of the current loop. |
ReadState : CifTextReadState | public | The read state of the reader instance. |
Value : String | public | The value of the current primitive field / loop field / comment. |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | Closes the reader instance and the underlying source stream. |
Read() : Boolean | public | Reads the next item. |
ResetState() : Void | public | Resets the state of the reader instance. |
SetSource() : Void | public | Sets the source stream. |
SetSource() : Void | public | Sets the source stream. |
SetSourceText() : Void | public | Sets the source text. |
CifTRException Class
Summary
public class CifTRException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifTRException() | public | Initializes a new instance of the class. |
CifTRException() | public | |
Property Members
Method Members
CifTextWriter Class
Summary
public class CifTextWriter
CifTextWriter: A writer that provides a fast, non-cached, forward-only way to write valid CIF streams or files. Duplication of names or fields is not checked.
Constructor Members
Name | Access | Summary |
---|
CifTextWriter() | public | Creates a new CifTextWriter instance. The writer is in a closed state, until the target is set by calling the SetTarget method. |
CifTextWriter() | public | Creates a new CifTextWriter instance. |
CifTextWriter() | public | Creates a new CifTextWriter instance. |
Field Members
Name | Access | Summary |
---|
BlockIndent : Int32 | public | . |
ColumnLimit : Int32 | public | . |
DefaultBlank : Char | public | . |
FrameIndent : Int32 | public | . |
IndentChar : Char | public | . |
LoopIndent : Int32 | public | . |
NameLimit : Int32 | public | . |
NewLine : String | public | The newline string. |
Property Members
Name | Access | Summary |
---|
Indent : Int32 | public | The current indentation level. |
WriteState : CifTextWriteState | public | The write state. |
Method Members
Name | Access | Summary |
---|
Close() : Void | public | Closes the CifTextWriter instance and the underlying target TextWriter instance. |
Flush() : Void | public | Flushes the target. |
SetTarget() : Void | public | Sets the target. |
SetTarget() : Void | public | Sets the target. |
WriteBlock() : Void | public | Writes a data block with the name. |
WriteComment() : Void | public | Writes a comment. |
WriteComment() : Void | public | Writes a comment. |
WriteEndFrame() : Void | public | Writes the end of a save frame. |
WriteEndLoop() : Void | public | Writes the end of a data loop, (check the integrity and end the LOOP state). |
WriteField() : Void | public | Fills a data loop field with the value. |
WriteField() : Void | public | Fills a data loop field with the value, in the specified literal form if possible. |
WriteField() : Void | public | Writes a primitive data field with the name and value pair. |
WriteField() : Void | public | Writes a primitive data field with the name and value, in the specified literal form if possible. |
WriteFrame() : Void | public | Writes a save frame with the name. |
WriteLoop() : Void | public | Writes a data loop with the field names. |
WriteLoop() : Void | public | Writes a data loop with the field names. |
WriteNewLine() : Void | public | Writes an empty line. |
CifTWException Class
Summary
public class CifTWException : Exception, System.Runtime.Serialization.ISerializable
.
This type has the following attributes: System.SerializableAttribute
Constructor Members
Name | Access | Summary |
---|
CifTWException() | public | Initializes a new instance of the class. |
CifTWException() | public | |
Property Members
Method Members