Namespace List

The namespaces specified in this document are:

NamespaceAssembly
AStar.CommonAStar
AStar.CifAStar
AStar.StarAStar

Namespace : AStar.Common



AStar.Common Type List

Interfaces

TypeSummary
INamed The INamed Interface, for a named item in the NamedItemCollection.

Structs

TypeSummary
Measurand The Measurand, value with the associated standard uncertainty (su / esd), in the double precision.

Classes

TypeSummary
NamedItemCollection The NamedItemCollection Class.
NameDuplicateException .
NameNotFoundException .


AStar.Common Interfaces

INamed Interface

Summary

public interface INamed

The INamed Interface, for a named item in the NamedItemCollection.

Property Members

NameAccessSummary
Name : Stringpublic 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

NameAccessSummary
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

NameAccessSummary
Su : Doublepublic The associated standard uncertainty, (aka. esd).
Value : Doublepublic The measurand value.

Method Members

NameAccessSummary
Parse() : Measurandpublic Converts the string to a Measurand instance.
ToString() : Stringpublic Converts the Measurand instance to its string representation.
ToString() : Stringpublic Converts the Measurand instance to its string representation.
ToString() : Stringpublic Converts the Measurand instance to its string representation.
ToString() : Stringpublic 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

NameAccessSummary
NamedItemCollection()public The default constructor.
NamedItemCollection()public Constructor with the items to be copied.
NamedItemCollection()public Constructor with the initial capacity specified.

Field Members

NameAccessSummary
km : String,`0}protected
vs : List{`0}protected

Property Members

NameAccessSummary
Capacity : Int32public The total number of items the internal list can hold without resizing.
Count : Int32public The number of items in the collection.
IsReadOnly : Booleanpublic
Item : `0public Gets/Sets an item by the order in the collection.
Item : `0public Gets/Sets an item by the name.

Method Members

NameAccessSummary
Add() : Voidpublic Adds an item to the collection.
AddRange() : Voidprotected Adds the items to the collection.
Clear() : Voidpublic Clears all items in the collection.
Contains() : Booleanpublic Checks whether the collection contains the item. [X]
Contains() : Booleanpublic Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic Copies the entire collection to a compatible one-dimensional array, starting at the beginning of the target array.
CopyTo() : Voidpublic Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
CopyTo() : Voidpublic Copies a range of items from the collection to a compatible one-dimensional array, starting at the specified index of the target array.
Get() : `0public Gets the item with the specified name.
GetEnumerator() : IEnumerator{`0}public The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
IndexOf() : Int32public Gets the index of the item. [X]
IndexOf() : Int32public Gets the index of the item with the specified name.
Insert() : Voidpublic Inserts item in the specified index.
InsertRange() : Voidprotected Inserts the items in the specified index.
Remove() : Booleanpublic Removes the item from the collection.
Remove() : Booleanpublic Removes the item with the name from the collection.
RemoveAt() : Booleanpublic Removes the item at the index.
RemoveRange() : Booleanprotected .
ToArray() : `0[]public Copies the items of the collection to a new array.
TryGet() : Booleanpublic Gets the item with the specified name, (using TryGetValue of Dictionary).
TryGetR() : Booleanpublic 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

NameAccessSummary
NameDuplicateException()publicInitializes a new instance of the class.
NameDuplicateException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary

NameNotFoundException Class

Summary

public class NameNotFoundException : Exception, System.Runtime.Serialization.ISerializable

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
NameNotFoundException()publicInitializes a new instance of the class.
NameNotFoundException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary

Namespace : AStar.Star



AStar.Star Type List

Enumerations

TypeSummary
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

TypeSummary
StarBlock A STAR data block.
StarField The abstract base class of StarPrimitiveField and StarLoopField.
StarFieldCollection A collection of StarField objects.
StarFrame A STAR save-frame object.
StarFrameCollection A collection of StarFrame objects.
StarFrameRef .
StarLoop A collection of StarLoopField objects, grouping the looped fields in the StarFieldCollection object, represents a STAR loop structure in the source.
StarLoopField A STAR loop field.
StarLoopRow .
StarPack The top-level collection of STAR data objects, a packing of data blocks in a STAR file.
StarPackException StarPackException.
StarPackReader A reader that creates StarPack objects from the STAR streams or files.
StarPackWriter A writer that provides a way to write StarPack objects to streams or files.
StarPRError .
StarPRException .
StarPrimitiveField A primitive field, represents a tag - value pair in the source. The 0-dimensional (.Level == 0) data container holding a single StarValue.
StarPWError .
StarPWException .
StarValue StarValue, the premitive data type of a STAR file.
StarXData Represents the data in a field, atomic data (level 0) or list.
StarXList StarValueList.


AStar.Star Enumerations

StarFieldType Enumeration

Summary

public enumeration StarFieldType

The type of a field, primitive or loop.

Enumeration Members

FieldSummary
Loop A loop(ed) field.
Primitive A primitive field.

StarXDataType Enumeration

Summary

public enumeration StarXDataType

.

Enumeration Members

FieldSummary
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

FieldSummary
Any
DQ
NQ
SC
SQ

StarPWErrorCode Enumeration

Summary

public enumeration StarPWErrorCode

.

Enumeration Members

FieldSummary
InvalidName
InvalidTag
InvalidValue
LoopNotIntegral

StarPRErrorCode Enumeration

Summary

public enumeration StarPRErrorCode

.

Enumeration Members

FieldSummary
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

NameAccessSummary
StarPack()public Creates an empty StarPack instance.
StarPack()public Creates a new StarPack instance from the STAR file.

Field Members

NameAccessSummary
km : StarBlock}protected(from AStar.Common.NamedItemCollection`1)
vs : StarBlock}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
Global : StarBlockpublic The global data block.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : StarBlockpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : StarBlockpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.

Method Members

NameAccessSummary
Add() : Voidpublic(from AStar.Common.NamedItemCollection`1)
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Common.NamedItemCollection`1) Clears all items in the collection.
Clone() : StarPackpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
Get() : StarBlockpublic(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() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Common.NamedItemCollection`1)
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Load() : Voidpublic .
Load() : Voidpublic .
Load() : Voidpublic Loads data from a STAR file.
Load() : Voidpublic Loads data from a STAR file.
Merge() : Voidpublic .
Merge() : Voidpublic .
Merge() : StarPackpublic .
Parse() : Voidpublic Parses the STAR source string.
Parse() : Voidpublic .
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection.
RemoveAt() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item at the index.
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
Save() : Voidpublic .
Save() : Voidpublic .
Save() : Voidpublic Saves the data to a STAR file.
Save() : Voidpublic .
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() : Stringpublic Returns a STAR source string which represents the data in the StarPack object.
ToText() : Stringpublic .
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
StarFieldCollection()protectedInitializes a new instance of the class.

Field Members

NameAccessSummary
comment : StringfamilyOrAssembly
km : StarField}protected(from AStar.Common.NamedItemCollection`1)
name : StringfamilyOrAssembly
vs : StarField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.
Loops : StarLoop}public .
Name : Stringpublic The name of the collection, used as the identifier of a StarFrame or StarBlock instance.
Primitives : StarPrimitiveField}public .

Method Members

NameAccessSummary
Add() : Voidpublic This method overrides the base class's definition, to prevent adding a loop field.
Add() : Voidpublic Adds a data loop to the collection.
Add() : Voidpublic Adds a primitive field to the collection.
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
Contains() : Booleanpublic .
Contains() : Booleanpublic .
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : Voidpublic Creates a primitive field in the collection.
Get() : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets the item with the specified name.
GetData() : StarXDatapublic .
GetData() : StarXDatapublic .
GetEnumerator() : StarField}public(from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
GetLevel() : Int32public .
GetList() : StarXListpublic .
GetList() : StarXListpublic .
GetList() : StarXListpublic .
GetLoop() : StarLooppublic Gets the loop which contains a field with the name.
GetLoop() : StarLooppublic Gets the loop which contains fields with the name and names.
GetRef() : StarFrameRefpublic .
GetRef() : StarFrameRefpublic .
GetValue() : StarValuepublic .
GetValue() : StarValuepublic .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic This method overrides the base class's definition, to prevent inserting a loop field.
Insert() : Voidpublic Inserts a data loop to the collection.
Insert() : Voidpublic .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic .
Query() : Booleanpublic
Query() : Booleanpublic
Query() : Booleanpublic
Query() : Booleanpublic
Remove() : Booleanpublic .
Remove() : Booleanpublic .
RemoveAt() : Booleanpublic .
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
SetData() : StarXDatapublic .
SetList() : StarXListpublic .
SetRef() : StarFrameRefpublic .
SetValue() : StarValuepublic .
ToArray() : StarField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
StarBlock()public Creates a new StarBlock instance, (for a global_ block).
StarBlock()public Creates a new StarBlock instance.
StarBlock()public .

Field Members

NameAccessSummary
comment : StringfamilyOrAssembly(from AStar.Star.StarFieldCollection)
Frames : StarFrameCollectionpublic .
km : StarField}protected(from AStar.Common.NamedItemCollection`1)
name : StringfamilyOrAssembly(from AStar.Star.StarFieldCollection)
vs : StarField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic(from AStar.Star.StarFieldCollection) .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.
Loops : StarLoop}public(from AStar.Star.StarFieldCollection) .
Name : Stringpublic(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

NameAccessSummary
Add() : Voidpublic(from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent adding a loop field.
Add() : Voidpublic(from AStar.Star.StarFieldCollection) Adds a data loop to the collection.
Add() : Voidpublic(from AStar.Star.StarFieldCollection) Adds a primitive field to the collection.
AddFrame() : Voidpublic eq. to .Frames.Add(frame).
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Star.StarFieldCollection) .
Clone() : StarBlockpublic
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
Contains() : Booleanpublic(from AStar.Star.StarFieldCollection) .
Contains() : Booleanpublic(from AStar.Star.StarFieldCollection) .
ContainsFrame() : Booleanpublic eq. to .Frames.Contains(name).
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : Voidpublic(from AStar.Star.StarFieldCollection) Creates a primitive field in the collection.
Get() : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets the item with the specified name.
GetData() : StarXDatapublic(from AStar.Star.StarFieldCollection) .
GetData() : StarXDatapublic(from AStar.Star.StarFieldCollection) .
GetEnumerator() : StarField}public(from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
GetFrame() : StarFramepublic .
GetFrame() : StarFramepublic eq. to .Frames[name].
GetLevel() : Int32public(from AStar.Star.StarFieldCollection) .
GetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
GetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
GetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
GetLoop() : StarLooppublic(from AStar.Star.StarFieldCollection) Gets the loop which contains a field with the name.
GetLoop() : StarLooppublic(from AStar.Star.StarFieldCollection) Gets the loop which contains fields with the name and names.
GetRef() : StarFrameRefpublic(from AStar.Star.StarFieldCollection) .
GetRef() : StarFrameRefpublic(from AStar.Star.StarFieldCollection) .
GetValue() : StarValuepublic(from AStar.Star.StarFieldCollection) .
GetValue() : StarValuepublic(from AStar.Star.StarFieldCollection) .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field.
Insert() : Voidpublic(from AStar.Star.StarFieldCollection) Inserts a data loop to the collection.
Insert() : Voidpublic(from AStar.Star.StarFieldCollection) .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic
Merge() : Voidpublic
Merge() : Voidpublic(from AStar.Star.StarFieldCollection) .
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Remove() : Booleanpublic(from AStar.Star.StarFieldCollection) .
Remove() : Booleanpublic(from AStar.Star.StarFieldCollection) .
RemoveAt() : Booleanpublic(from AStar.Star.StarFieldCollection) .
RemoveFrame() : Booleanpublic .
RemoveFrame() : Booleanpublic eq. to .Frames.Remove(name).
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
SetData() : StarXDatapublic(from AStar.Star.StarFieldCollection) .
SetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
SetRef() : StarFrameRefpublic(from AStar.Star.StarFieldCollection) .
SetValue() : StarValuepublic(from AStar.Star.StarFieldCollection) .
ToArray() : StarField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
StarFrameCollection()publicInitializes a new instance of the class.

Field Members

NameAccessSummary
km : StarFrame}protected(from AStar.Common.NamedItemCollection`1)
vs : StarFrame}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : StarFramepublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : StarFramepublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.

Method Members

NameAccessSummary
Add() : Voidpublic(from AStar.Common.NamedItemCollection`1)
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Common.NamedItemCollection`1) Clears all items in the collection.
Clone() : StarFrameCollectionpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
Get() : StarFramepublic(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() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Common.NamedItemCollection`1)
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic .
Merge() : Voidpublic .
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection.
RemoveAt() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item at the index.
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
ToArray() : StarFrame[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
StarFrame()public Creates a new StarFrame instance.
StarFrame()public .

Field Members

NameAccessSummary
comment : StringfamilyOrAssembly(from AStar.Star.StarFieldCollection)
km : StarField}protected(from AStar.Common.NamedItemCollection`1)
name : StringfamilyOrAssembly(from AStar.Star.StarFieldCollection)
vs : StarField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic(from AStar.Star.StarFieldCollection) .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.
Loops : StarLoop}public(from AStar.Star.StarFieldCollection) .
Name : Stringpublic(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

NameAccessSummary
Add() : Voidpublic(from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent adding a loop field.
Add() : Voidpublic(from AStar.Star.StarFieldCollection) Adds a data loop to the collection.
Add() : Voidpublic(from AStar.Star.StarFieldCollection) Adds a primitive field to the collection.
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Star.StarFieldCollection) .
Clone() : StarFramepublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
Contains() : Booleanpublic(from AStar.Star.StarFieldCollection) .
Contains() : Booleanpublic(from AStar.Star.StarFieldCollection) .
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : Voidpublic(from AStar.Star.StarFieldCollection) Creates a primitive field in the collection.
Get() : StarFieldpublic(from AStar.Common.NamedItemCollection`1) Gets the item with the specified name.
GetData() : StarXDatapublic(from AStar.Star.StarFieldCollection) .
GetData() : StarXDatapublic(from AStar.Star.StarFieldCollection) .
GetEnumerator() : StarField}public(from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
GetLevel() : Int32public(from AStar.Star.StarFieldCollection) .
GetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
GetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
GetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
GetLoop() : StarLooppublic(from AStar.Star.StarFieldCollection) Gets the loop which contains a field with the name.
GetLoop() : StarLooppublic(from AStar.Star.StarFieldCollection) Gets the loop which contains fields with the name and names.
GetRef() : StarFrameRefpublic(from AStar.Star.StarFieldCollection) .
GetRef() : StarFrameRefpublic(from AStar.Star.StarFieldCollection) .
GetValue() : StarValuepublic(from AStar.Star.StarFieldCollection) .
GetValue() : StarValuepublic(from AStar.Star.StarFieldCollection) .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Star.StarFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field.
Insert() : Voidpublic(from AStar.Star.StarFieldCollection) Inserts a data loop to the collection.
Insert() : Voidpublic(from AStar.Star.StarFieldCollection) .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic(from AStar.Star.StarFieldCollection) .
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Query() : Booleanpublic(from AStar.Star.StarFieldCollection)
Remove() : Booleanpublic(from AStar.Star.StarFieldCollection) .
Remove() : Booleanpublic(from AStar.Star.StarFieldCollection) .
RemoveAt() : Booleanpublic(from AStar.Star.StarFieldCollection) .
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
SetData() : StarXDatapublic(from AStar.Star.StarFieldCollection) .
SetList() : StarXListpublic(from AStar.Star.StarFieldCollection) .
SetRef() : StarFrameRefpublic(from AStar.Star.StarFieldCollection) .
SetValue() : StarValuepublic(from AStar.Star.StarFieldCollection) .
ToArray() : StarField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
StarField()protectedInitializes a new instance of the class.

Field Members

NameAccessSummary
name : StringfamilyOrAssembly

Property Members

NameAccessSummary
Data : StarXDatapublic
Level : Int32public
List : StarXListpublic
Name : Stringpublic .
Ref : StarFrameRefpublic
Type : StarFieldTypepublic
Value : StarValuepublic

Method Members

NameAccessSummary

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

NameAccessSummary
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

NameAccessSummary
name : StringfamilyOrAssembly(from AStar.Star.StarField)

Property Members

NameAccessSummary
Data : StarXDatapublic The associated field data.
Level : Int32public Returns 0.
List : StarXListpublic The associated field data (StarValueList), always null.
Name : Stringpublic(from AStar.Star.StarField) .
Ref : StarFrameRefpublic The associated field data (StarFrameRef).
Type : StarFieldTypepublic Returns StarFieldType.Primitive.
Value : StarValuepublic The associated field data (StarValue).

Method Members

NameAccessSummary
Clone() : StarPrimitiveFieldpublic .

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

NameAccessSummary
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

NameAccessSummary
km : StarLoopField}protected(from AStar.Common.NamedItemCollection`1)
vs : StarLoopField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
ColumnCount : Int32public .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsIntegral : Booleanpublic Indicates whether the loop structure is integral.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : StarXDatapublic Gets/Sets a value at the specified row and column indexes.
Item : StarXDatapublic Gets/Sets a value specified by the row index and field name.
Level : Int32public .
Loop : StarLooppublic .
RowCount : Int32public .
Rows : StarLoopRow}public .

Method Members

NameAccessSummary
Add() : Voidpublic .
Add() : Voidpublic .
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
AddRow() : StarLoopRowpublic .
CheckIntegrity() : Booleanpublic 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() : Voidpublic .
Clone() : StarLooppublic Note the Fill state is not cloned.
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : StarLoopFieldpublic .
Fill() : Booleanpublic .
Get() : StarLoopFieldpublic(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() : StarLooppublic 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() : StarLoopRowpublic .
GetVariant() : StarLooppublic Gets the StarLoop variant, with the similar structure but in a different level.
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic .
Insert() : Voidpublic .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
InsertRow() : StarLoopRowpublic .
Remove() : Booleanpublic .
Remove() : Booleanpublic .
RemoveAt() : Booleanpublic .
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
RemoveRowAt() : Booleanpublic .
Stop() : Voidpublic .
ToArray() : StarLoopField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
StarLoopField()public .
StarLoopField()public .

Field Members

NameAccessSummary
name : StringfamilyOrAssembly(from AStar.Star.StarField)

Property Members

NameAccessSummary
Data : StarXDatapublic .
Level : Int32public The level of the field.
List : StarXListpublic .
Loop : StarLooppublic The StarLoop instance which directly contains the StarLoopField instance.
Name : Stringpublic(from AStar.Star.StarField) .
Ref : StarFrameRefpublic .
Type : StarFieldTypepublic The type of the field, always returns StarFieldType.Loop.
Value : StarValuepublic .

Method Members

NameAccessSummary
Clone() : StarLoopFieldpublic .
GetLoop() : StarLooppublic .
GetVariant() : StarLoopFieldpublic .

StarLoopRow Class

Summary

public class StarLoopRow

.

Property Members

NameAccessSummary
Count : Int32public .
Item : StarValuepublic .
Item : StarValuepublic .
Loop : StarLooppublic .
Position : Int32public .

Method Members

NameAccessSummary
Contains() : Booleanpublic .

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

NameAccessSummary
StarXData()protectedInitializes a new instance of the class.

Property Members

NameAccessSummary
Level : Int32public .
Type : StarXDataTypepublic The type ID of StarXData.

Method Members

NameAccessSummary
AsList() : StarXListpublic .
AsRef() : StarFrameRefpublic .
AsValue() : StarValuepublic .

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

NameAccessSummary
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

NameAccessSummary
Default : StarValuepublic (.).
Unknown : StarValuepublic (?).

Property Members

NameAccessSummary
Level : Int32public .
Literal : StarValueLiteralpublic Marks the original or prefered literal form of the StarRealValue instance.
Type : StarXDataTypepublic .

Method Members

NameAccessSummary
AsList() : StarXListpublic .
AsRef() : StarFrameRefpublic .
AsValue() : StarValuepublic .
Clone() : StarValuepublic .
CompareTo() : Int32public .
Equals() : Booleanpublic .
Equals() : Booleanpublic .
GetHashCode() : Int32public .
IsDefault() : Booleanpublic .
IsUnknown() : Booleanpublic .
ToInt32() : Int32public Converts the StarValue instance to an (Int32) integer.
ToInt64() : Int64public Converts the StarValue instance to an (Int64) integer.
ToLower() : StarValuepublic .
ToMeasurand() : Measurandpublic Converts the StarValue instance to a Measurand instance.
ToNumber() : Doublepublic Converts the StarValue instance to a number (double).
ToString() : Stringpublic Converts the StarValue instance to a string.
ToUpper() : StarValuepublic .

StarFrameRef Class

Summary

public class StarFrameRef : StarXData

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
StarFrameRef()public .

Property Members

NameAccessSummary
Level : Int32public .
Type : StarXDataTypepublic .

Method Members

NameAccessSummary
AsList() : StarXListpublic .
AsRef() : StarFrameRefpublic .
AsValue() : StarValuepublic .
Clone() : StarFrameRefpublic .
ToString() : Stringpublic .

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

NameAccessSummary
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

NameAccessSummary
Count : Int32public .
IsReadOnly : Booleanpublic .
Item : StarXDatapublic .
Level : Int32public .
Type : StarXDataTypepublic .

Method Members

NameAccessSummary
Add() : Voidpublic .
AsList() : StarXListpublic .
AsRef() : StarFrameRefpublic .
AsValue() : StarValuepublic .
Clear() : Voidpublic .
Clone() : StarXListpublic .
Contains() : Booleanpublic .
CopyTo() : Voidpublic .
CopyTo() : Voidpublic .
GetEnumerator() : StarXData}public .
IndexOf() : Int32public .
Insert() : Voidpublic .
Remove() : Booleanpublic .
RemoveAt() : Voidpublic .
ToArray() : StarXData[]public .
ToArrayOfString() : String[]public .
ToString() : Stringpublic .
ToString() : Stringpublic .

StarPackException Class

Summary

public class StarPackException : Exception, System.Runtime.Serialization.ISerializable

StarPackException.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
StarPackException()publicInitializes a new instance of the class.
StarPackException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary

StarPackWriter Class

Summary

public class StarPackWriter

A writer that provides a way to write StarPack objects to streams or files.

Constructor Members

NameAccessSummary
StarPackWriter()public Creates a new StarPackWriter instance.
StarPackWriter()public Creates a new StarPackWriter instance.
StarPackWriter()public Creates a new StarPackWriter instance.

Field Members

NameAccessSummary
BlockIndent : Int32public
DefaultBlank : Charpublic
Error_InvalidName : Int32public
Error_InvalidTag : Int32public
Error_InvalidValue : Int32public
Error_LoopNotIntegral : Int32public
ErrorCountLimit : Int32public Maximum allowed number of errors, StarPackWriter will abort the Write process and throw a SPWException when this limit is exceeded.
FrameIndent : Int32public
IndentChar : Charpublic
LoopIndent : Int32public
NewLine : Stringpublic The newline string.

Property Members

NameAccessSummary
ErrorCount : Int32public The error count.
ErrorList : StarPWError[]public The error information list.
Indent : Int32public The current indentation level.

Method Members

NameAccessSummary
Close() : Voidpublic Closes the target writer.
Flush() : Voidpublic Flushs the target writer.
SetTarget() : Voidpublic Sets the target.
SetTarget() : Voidpublic Sets the target.
Write() : Voidpublic Writes a StarBlock.
Write() : Voidpublic Writes a StarPack.

StarPWException Class

Summary

public class StarPWException : Exception, System.Runtime.Serialization.ISerializable

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
StarPWException()public
StarPWException()public

Property Members

NameAccessSummary
ErrorList : StarPWError[]public

Method Members

NameAccessSummary

StarPWError Class

Summary

public class StarPWError

.

Constructor Members

NameAccessSummary
StarPWError()public
StarPWError()public

Field Members

NameAccessSummary
EColumn : Int32public
ELine : Int32public
SColumn : Int32public
SLine : Int32public

Property Members

NameAccessSummary
Code : Int32public Error code.
Column : Int32public Column number, 1-based.
Description : Stringpublic Error details.
Line : Int32public Line number, 1-based.

Method Members

NameAccessSummary

StarPackReader Class

Summary

public class StarPackReader

A reader that creates StarPack objects from the STAR streams or files.

Constructor Members

NameAccessSummary
StarPackReader()public Creates a new StarPackReader instance.
StarPackReader()public Creates a new StarPackReader instance.
StarPackReader()public Creates a new StarPackReader instance.

Field Members

NameAccessSummary
ErrorCountLimit : Int32public 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 : Stringpublic .
NormalizeNewLines : Booleanpublic .

Property Members

NameAccessSummary
ErrorCount : Int32public Count of errors, non-zero if there are syntactic/semantic errors.
ErrorList : StarPRError[]public A detailed error information list.

Method Members

NameAccessSummary
Close() : Voidpublic Closes the reader instance and the underlying source stream.
Read() : StarPackpublic Reads a StarPack object from the source.
Read() : StarPackpublic Reads a StarPack object from the source.
SetSource() : Voidpublic Sets the source stream.
SetSource() : Voidpublic Sets the source stream.
SetSourceText() : Voidpublic 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

NameAccessSummary
StarPRException()public
StarPRException()public

Property Members

NameAccessSummary
ErrorList : StarPRError[]public .

Method Members

NameAccessSummary

StarPRError Class

Summary

public class StarPRError

.

Constructor Members

NameAccessSummary
StarPRError()public
StarPRError()public

Field Members

NameAccessSummary
EColumn : Int32public
ELine : Int32public
SColumn : Int32public
SLine : Int32public

Property Members

NameAccessSummary
Code : Int32public Error code.
Column : Int32public Column number.
Description : Stringpublic Error details.
Line : Int32public Line number.

Method Members

NameAccessSummary

Namespace : AStar.Cif



AStar.Cif Type List

Interfaces

TypeSummary
ICifValidationHandler .

Enumerations

TypeSummary
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

TypeSummary
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

NameAccessSummary
IsValid : Booleanpublic

Method Members

NameAccessSummary
OnError() : Voidpublic
OnMessage() : Voidpublic


AStar.Cif Enumerations

CifFieldType Enumeration

Summary

public enumeration CifFieldType

The type of a field, primitive or loop.

Enumeration Members

FieldSummary
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

FieldSummary
Any
DQ
NQ
SC
SQ

CifDMergingMode Enumeration

Summary

public enumeration CifDMergingMode

.

Enumeration Members

FieldSummary
Overlay
Replace
Strict

CifValidationCode Enumeration

Summary

public enumeration CifValidationCode

The message IDs or error codes for CIF validation against DDL1/DDL2 dictionaries.

Enumeration Members

FieldSummary
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

FieldSummary
ColumnLimit
InvalidName
InvalidTag
InvalidValue
LoopNotIntegral
NameLimit

CifPRErrorCode Enumeration

Summary

public enumeration CifPRErrorCode

.

Enumeration Members

FieldSummary
ColumnLimit
DuplicateBlockName
DuplicateFieldName
DuplicateFrameName
GlobalBlock
InvalidChar
LoopNotIntegral
MissingQuote
NameLimit
SaveFrameRef
UnexpectedInBlock
UnexpectedInFrame
UnexpectedInTop

CifContentType Enumeration

Summary

public enumeration CifContentType

.

Enumeration Members

FieldSummary
Block
Comment
EndBlock
EndFrame
EndLoop
Field
Frame
Loop
None

CifTextReadState Enumeration

Summary

public enumeration CifTextReadState

.

Enumeration Members

FieldSummary
Closed
EndOfFile
Error
Initial
Interactive

CifTextWriteState Enumeration

Summary

public enumeration CifTextWriteState

.

Enumeration Members

FieldSummary
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

NameAccessSummary
CifPack()public Creates an empty CifPack instance.
CifPack()public Creates a new CifPack instance from the CIF file.

Field Members

NameAccessSummary
km : CifBlock}protected(from AStar.Common.NamedItemCollection`1)
vs : CifBlock}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : CifBlockpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : CifBlockpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.

Method Members

NameAccessSummary
Add() : Voidpublic(from AStar.Common.NamedItemCollection`1)
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Common.NamedItemCollection`1) Clears all items in the collection.
Clone() : CifPackpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
Get() : CifBlockpublic(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() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Common.NamedItemCollection`1)
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Load() : Voidpublic .
Load() : Voidpublic .
Load() : Voidpublic Loads data from a CIF file.
Load() : Voidpublic Loads data from a CIF file.
Merge() : Voidpublic .
Merge() : Voidpublic .
Merge() : CifPackpublic .
Parse() : Voidpublic Parses the CIF source string.
Parse() : Voidpublic .
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection.
RemoveAt() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item at the index.
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
Save() : Voidpublic .
Save() : Voidpublic .
Save() : Voidpublic Saves the data to a CIF file.
Save() : Voidpublic .
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() : Stringpublic Returns a CIF source string which represents the data in the CifPack object.
ToText() : Stringpublic .
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
CifFieldCollection()protectedInitializes a new instance of the class.

Field Members

NameAccessSummary
comment : StringfamilyOrAssembly
km : CifField}protected(from AStar.Common.NamedItemCollection`1)
name : StringfamilyOrAssembly
vs : CifField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.
Loops : CifLoop}public .
Name : Stringpublic The name of the collection, used as the identifier of a CifFrame or CifBlock instance.
Primitives : CifPrimitiveField}public .

Method Members

NameAccessSummary
Add() : Voidpublic This method overrides the base class's definition, to prevent adding a loop field.
Add() : Voidpublic Adds a data loop to the collection.
Add() : Voidpublic Adds a primitive field to the collection.
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
Contains() : Booleanpublic .
Contains() : Booleanpublic .
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : Voidpublic Creates a primitive field in the collection.
Get() : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets the item with the specified name.
GetData() : CifXDatapublic .
GetData() : CifXDatapublic .
GetEnumerator() : CifField}public(from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
GetLevel() : Int32public .
GetList() : CifValueListpublic .
GetList() : CifValueListpublic .
GetList() : CifValueListpublic .
GetList() : CifValueListpublic .
GetLoop() : CifLooppublic Gets the loop which contains a field with the name.
GetLoop() : CifLooppublic Gets the loop which contains fields with the name and names.
GetValue() : CifValuepublic .
GetValue() : CifValuepublic .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic This method overrides the base class's definition, to prevent inserting a loop field.
Insert() : Voidpublic Inserts a data loop to the collection.
Insert() : Voidpublic .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic .
Query() : Booleanpublic
Query() : Booleanpublic
Query() : Booleanpublic
Remove() : Booleanpublic .
Remove() : Booleanpublic .
RemoveAt() : Booleanpublic .
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
SetData() : CifXDatapublic .
SetList() : CifValueListpublic .
SetValue() : CifValuepublic .
ToArray() : CifField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
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

NameAccessSummary
comment : StringfamilyOrAssembly(from AStar.Cif.CifFieldCollection)
Frames : CifFrameCollectionpublic .
km : CifField}protected(from AStar.Common.NamedItemCollection`1)
name : StringfamilyOrAssembly(from AStar.Cif.CifFieldCollection)
vs : CifField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic(from AStar.Cif.CifFieldCollection) .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.
Loops : CifLoop}public(from AStar.Cif.CifFieldCollection) .
Name : Stringpublic(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

NameAccessSummary
Add() : Voidpublic(from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent adding a loop field.
Add() : Voidpublic(from AStar.Cif.CifFieldCollection) Adds a data loop to the collection.
Add() : Voidpublic(from AStar.Cif.CifFieldCollection) Adds a primitive field to the collection.
AddFrame() : Voidpublic eq. to .Frames.Add(frame).
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Cif.CifFieldCollection) .
Clone() : CifBlockpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
Contains() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
Contains() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
ContainsFrame() : Booleanpublic eq. to .Frames.Contains(name).
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : Voidpublic(from AStar.Cif.CifFieldCollection) Creates a primitive field in the collection.
Get() : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets the item with the specified name.
GetData() : CifXDatapublic(from AStar.Cif.CifFieldCollection) .
GetData() : CifXDatapublic(from AStar.Cif.CifFieldCollection) .
GetEnumerator() : CifField}public(from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
GetFrame() : CifFramepublic eq. to .Frames[name].
GetLevel() : Int32public(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetLoop() : CifLooppublic(from AStar.Cif.CifFieldCollection) Gets the loop which contains a field with the name.
GetLoop() : CifLooppublic(from AStar.Cif.CifFieldCollection) Gets the loop which contains fields with the name and names.
GetValue() : CifValuepublic(from AStar.Cif.CifFieldCollection) .
GetValue() : CifValuepublic(from AStar.Cif.CifFieldCollection) .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field.
Insert() : Voidpublic(from AStar.Cif.CifFieldCollection) Inserts a data loop to the collection.
Insert() : Voidpublic(from AStar.Cif.CifFieldCollection) .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic .
Merge() : Voidpublic .
Merge() : Voidpublic(from AStar.Cif.CifFieldCollection) .
Query() : Booleanpublic(from AStar.Cif.CifFieldCollection)
Query() : Booleanpublic(from AStar.Cif.CifFieldCollection)
Query() : Booleanpublic(from AStar.Cif.CifFieldCollection)
Remove() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
Remove() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
RemoveAt() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
RemoveFrame() : Booleanpublic .
RemoveFrame() : Booleanpublic eq. to .Frames.Remove(name).
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
SetData() : CifXDatapublic(from AStar.Cif.CifFieldCollection) .
SetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
SetValue() : CifValuepublic(from AStar.Cif.CifFieldCollection) .
ToArray() : CifField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
CifFrameCollection()publicInitializes a new instance of the class.

Field Members

NameAccessSummary
km : CifFrame}protected(from AStar.Common.NamedItemCollection`1)
vs : CifFrame}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : CifFramepublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : CifFramepublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.

Method Members

NameAccessSummary
Add() : Voidpublic(from AStar.Common.NamedItemCollection`1)
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Common.NamedItemCollection`1) Clears all items in the collection.
Clone() : CifFrameCollectionpublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
Get() : CifFramepublic(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() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Common.NamedItemCollection`1)
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic .
Merge() : Voidpublic .
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Remove() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item with the name from the collection.
RemoveAt() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Removes the item at the index.
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
ToArray() : CifFrame[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
CifFrame()public Creates a new CifFrame instance.
CifFrame()public .

Field Members

NameAccessSummary
comment : StringfamilyOrAssembly(from AStar.Cif.CifFieldCollection)
km : CifField}protected(from AStar.Common.NamedItemCollection`1)
name : StringfamilyOrAssembly(from AStar.Cif.CifFieldCollection)
vs : CifField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
Comment : Stringpublic(from AStar.Cif.CifFieldCollection) .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the order in the collection.
Item : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets/Sets an item by the name.
Loops : CifLoop}public(from AStar.Cif.CifFieldCollection) .
Name : Stringpublic(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

NameAccessSummary
Add() : Voidpublic(from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent adding a loop field.
Add() : Voidpublic(from AStar.Cif.CifFieldCollection) Adds a data loop to the collection.
Add() : Voidpublic(from AStar.Cif.CifFieldCollection) Adds a primitive field to the collection.
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Clear() : Voidpublic(from AStar.Cif.CifFieldCollection) .
Clone() : CifFramepublic .
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
Contains() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
Contains() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : Voidpublic(from AStar.Cif.CifFieldCollection) Creates a primitive field in the collection.
Get() : CifFieldpublic(from AStar.Common.NamedItemCollection`1) Gets the item with the specified name.
GetData() : CifXDatapublic(from AStar.Cif.CifFieldCollection) .
GetData() : CifXDatapublic(from AStar.Cif.CifFieldCollection) .
GetEnumerator() : CifField}public(from AStar.Common.NamedItemCollection`1) The implementation of System.Collections.Generic.IEnumerable<T>.GetEnumerator.
GetLevel() : Int32public(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
GetLoop() : CifLooppublic(from AStar.Cif.CifFieldCollection) Gets the loop which contains a field with the name.
GetLoop() : CifLooppublic(from AStar.Cif.CifFieldCollection) Gets the loop which contains fields with the name and names.
GetValue() : CifValuepublic(from AStar.Cif.CifFieldCollection) .
GetValue() : CifValuepublic(from AStar.Cif.CifFieldCollection) .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic(from AStar.Cif.CifFieldCollection) This method overrides the base class's definition, to prevent inserting a loop field.
Insert() : Voidpublic(from AStar.Cif.CifFieldCollection) Inserts a data loop to the collection.
Insert() : Voidpublic(from AStar.Cif.CifFieldCollection) .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
Merge() : Voidpublic(from AStar.Cif.CifFieldCollection) .
Query() : Booleanpublic(from AStar.Cif.CifFieldCollection)
Query() : Booleanpublic(from AStar.Cif.CifFieldCollection)
Query() : Booleanpublic(from AStar.Cif.CifFieldCollection)
Remove() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
Remove() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
RemoveAt() : Booleanpublic(from AStar.Cif.CifFieldCollection) .
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
SetData() : CifXDatapublic(from AStar.Cif.CifFieldCollection) .
SetList() : CifValueListpublic(from AStar.Cif.CifFieldCollection) .
SetValue() : CifValuepublic(from AStar.Cif.CifFieldCollection) .
ToArray() : CifField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
CifField()protectedInitializes a new instance of the class.

Field Members

NameAccessSummary
name : StringfamilyOrAssembly

Property Members

NameAccessSummary
Data : CifXDatapublic
Level : Int32public
List : CifValueListpublic
Name : Stringpublic .
Type : CifFieldTypepublic
Value : CifValuepublic

Method Members

NameAccessSummary

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

NameAccessSummary
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

NameAccessSummary
name : StringfamilyOrAssembly(from AStar.Cif.CifField)

Property Members

NameAccessSummary
Data : CifXDatapublic The associated field data.
Level : Int32public Returns 0.
List : CifValueListpublic The associated field data (CifValueList), always null.
Name : Stringpublic(from AStar.Cif.CifField) .
Type : CifFieldTypepublic Returns CifFieldType.Primitive.
Value : CifValuepublic The associated field data (CifValue).

Method Members

NameAccessSummary
Clone() : CifPrimitiveFieldpublic .

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

NameAccessSummary
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

NameAccessSummary
km : CifLoopField}protected(from AStar.Common.NamedItemCollection`1)
vs : CifLoopField}protected(from AStar.Common.NamedItemCollection`1)

Property Members

NameAccessSummary
Capacity : Int32public(from AStar.Common.NamedItemCollection`1) The total number of items the internal list can hold without resizing.
ColumnCount : Int32public .
Count : Int32public(from AStar.Common.NamedItemCollection`1) The number of items in the collection.
IsIntegral : Booleanpublic Indicates whether the loop structure is integral.
IsReadOnly : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Item : CifValuepublic Gets/Sets a value at the specified row and column indexes.
Item : CifValuepublic Gets/Sets a value specified by the row index and field name.
RowCount : Int32public .
Rows : CifLoopRow}public .

Method Members

NameAccessSummary
Add() : Voidpublic .
AddRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
AddRow() : CifLoopRowpublic .
CheckIntegrity() : Booleanpublic 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() : Voidpublic .
ClearData() : Voidpublic .
Clone() : CifLooppublic Note the Fill state is not cloned.
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
Contains() : Booleanpublic(from AStar.Common.NamedItemCollection`1) Checks whether the collection contains an item with the name.
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CopyTo() : Voidpublic(from AStar.Common.NamedItemCollection`1)
CreateField() : CifLoopFieldpublic .
CreateFields() : Voidpublic .
Fill() : Booleanpublic .
Get() : CifLoopFieldpublic(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() : CifLoopRowpublic .
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1)
IndexOf() : Int32public(from AStar.Common.NamedItemCollection`1) Gets the index of the item with the specified name.
Insert() : Voidpublic .
InsertRange() : Voidprotected(from AStar.Common.NamedItemCollection`1)
InsertRow() : CifLoopRowpublic .
Remove() : Booleanpublic .
Remove() : Booleanpublic .
RemoveAt() : Booleanpublic .
RemoveRange() : Booleanprotected(from AStar.Common.NamedItemCollection`1) .
RemoveRowAt() : Booleanpublic .
ToArray() : CifLoopField[]public(from AStar.Common.NamedItemCollection`1) Copies the items of the collection to a new array.
TryGet() : Booleanpublic(from AStar.Common.NamedItemCollection`1)
TryGetR() : Booleanpublic(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

NameAccessSummary
CifLoopField()public .

Field Members

NameAccessSummary
name : StringfamilyOrAssembly(from AStar.Cif.CifField)

Property Members

NameAccessSummary
Data : CifXDatapublic .
Level : Int32public The level of the field, always returns 1.
List : CifValueListpublic .
Loop : CifLooppublic The CifLoop instance which contains the CifLoopField instance.
Name : Stringpublic(from AStar.Cif.CifField) .
Type : CifFieldTypepublic The type of the field, always returns CifFieldType.Loop.
Value : CifValuepublic .

Method Members

NameAccessSummary
Clone() : CifLoopFieldpublic .

CifLoopRow Class

Summary

public class CifLoopRow

.

Property Members

NameAccessSummary
Count : Int32public .
Item : CifValuepublic .
Item : CifValuepublic .
Loop : CifLooppublic .
Position : Int32public .

Method Members

NameAccessSummary
Contains() : Booleanpublic .

CifXData Class

Summary

public abstract class CifXData

The base class of CifValue and CifValueList.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifXData()protectedInitializes a new instance of the class.

Property Members

NameAccessSummary
Level : Int32public .

Method Members

NameAccessSummary
AsList() : CifValueListpublic .
AsValue() : CifValuepublic .

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

NameAccessSummary
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

NameAccessSummary
Default : CifValuepublic (.).
Unknown : CifValuepublic (?).

Property Members

NameAccessSummary
Level : Int32public .
Literal : CifValueLiteralpublic Marks the original or prefered literal form of the CifValue instance.

Method Members

NameAccessSummary
AsList() : CifValueListpublic .
AsValue() : CifValuepublic .
Clone() : CifValuepublic .
CompareTo() : Int32public .
Equals() : Booleanpublic .
Equals() : Booleanpublic .
GetHashCode() : Int32public .
IsDefault() : Booleanpublic .
IsUnknown() : Booleanpublic .
ToInt32() : Int32public Converts the CifValue instance to an (Int32) integer.
ToInt64() : Int64public Converts the CifValue instance to an (Int64) integer.
ToLower() : CifValuepublic .
ToMeasurand() : Measurandpublic Converts the CifValue instance to a Measurand instance.
ToNumber() : Doublepublic Converts the CifValue instance to a number (double).
ToString() : Stringpublic Converts the CifValue instance to a string.
ToUpper() : CifValuepublic .

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

NameAccessSummary
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

NameAccessSummary
Count : Int32public .
IsReadOnly : Booleanpublic .
Item : CifValuepublic .
Level : Int32public .

Method Members

NameAccessSummary
Add() : Voidpublic .
AsList() : CifValueListpublic .
AsValue() : CifValuepublic .
Clear() : Voidpublic .
Clone() : CifValueListpublic .
Contains() : Booleanpublic .
CopyTo() : Voidpublic .
CopyTo() : Voidpublic .
GetEnumerator() : CifValue}public .
IndexOf() : Int32public .
Insert() : Voidpublic .
Remove() : Booleanpublic .
RemoveAt() : Voidpublic .
ToArray() : CifValue[]public .
ToArrayOfString() : String[]public .
ToString() : Stringpublic .
ToString() : Stringpublic .

CifPackException Class

Summary

public class CifPackException : Exception, System.Runtime.Serialization.ISerializable

CifPackException.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifPackException()publicInitializes a new instance of the class.
CifPackException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary

CifDictionary Class

Summary

public class CifDictionary

CifDictionary.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifDictionary()public .
CifDictionary()public .

Property Members

NameAccessSummary
MergingMode : CifDMergingModepublic
Name : Stringpublic
Specification : Stringpublic
Version : Stringpublic

Method Members

NameAccessSummary
Clear() : Voidpublic .
Load() : Voidpublic .
Load() : Voidpublic .
Load() : Voidpublic .
LoadDDL1() : Voidpublic .
LoadDDL2() : Voidpublic .
Validate() : Booleanpublic .
Validate() : Booleanpublic .
Validate() : Booleanpublic .
Validate() : Booleanpublic .
Validate() : Booleanpublic .

CifDField Class

Summary

public class CifDField

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifDField()publicInitializes a new instance of the class.

Field Members

NameAccessSummary
Aliases : String}public
Category : Stringpublic
DependentFields : String}public
Description : Stringpublic
DictionaryIndex : Int32public
EnumerationValues : CifValueListpublic
IsMandatory : Booleanpublic
Level : Int32public
ListReferencedFields : String}public
ListUniquenessFields : String}public
Name : Stringpublic
RangeMaxValues : CifValueListpublic
RangeMinValues : CifValueListpublic
RelatedFunctions : String}public
RelatedNames : String}public
Type : Stringpublic
TypeConditions : String}public
WithSu : Booleanpublic

Method Members

NameAccessSummary
Clone() : CifDFieldpublic

CifDRange Class

Summary

public class CifDRange

.

Constructor Members

NameAccessSummary
CifDRange()publicInitializes a new instance of the class.

Field Members

NameAccessSummary
Max : CifValuepublic
Min : CifValuepublic

Method Members

NameAccessSummary

CifDRelatedField Class

Summary

public class CifDRelatedField

.

Constructor Members

NameAccessSummary
CifDRelatedField()publicInitializes a new instance of the class.

Field Members

NameAccessSummary
Function : Stringpublic
Name : Stringpublic

Method Members

NameAccessSummary

CifDType Class

Summary

public class CifDType

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifDType()public
CifDType()public

Field Members

NameAccessSummary
Construct : Stringpublic
DictionaryIndex : Int32public
Name : Stringpublic
Primitive : Stringpublic

Method Members

NameAccessSummary
GetRegex() : Regexpublic
Test() : Booleanpublic

CifDCategory Class

Summary

public class CifDCategory

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifDCategory()publicInitializes a new instance of the class.

Field Members

NameAccessSummary
Description : Stringpublic
DictionaryIndex : Int32public
Keys : String}public
MandatoryFields : String}public
Name : Stringpublic

Method Members

NameAccessSummary

CifValidationResultBuilder Class

Summary

public class CifValidationResultBuilder : AStar.Cif.ICifValidationHandler

.

Constructor Members

NameAccessSummary
CifValidationResultBuilder()publicInitializes a new instance of the class.

Property Members

NameAccessSummary
IsValid : Booleanpublic

Method Members

NameAccessSummary
GetResult() : CifValidationResultpublic
OnError() : Voidpublic
OnMessage() : Voidpublic

CifValidationResult Class

Summary

public class CifValidationResult

.

Constructor Members

NameAccessSummary
CifValidationResult()public

Property Members

NameAccessSummary
ErrorCount : Int32public
ErrorList : CifValidationError[]public
Name : Stringpublic
SectionCount : Int32public
SectionList : CifValidationResult[]public
TotalErrorCount : Int32public
Type : Stringpublic

Method Members

NameAccessSummary
AddError() : Voidpublic
AddSection() : Voidpublic

CifValidationResultTextWriter Class

Summary

public class CifValidationResultTextWriter

.

Constructor Members

NameAccessSummary
CifValidationResultTextWriter()publicInitializes a new instance of the class.
CifValidationResultTextWriter()public
CifValidationResultTextWriter()public
CifValidationResultTextWriter()public

Property Members

NameAccessSummary
Target : TextWriterpublic

Method Members

NameAccessSummary
Close() : Voidpublic
Flush() : Voidpublic
Write() : Voidpublic
Write() : Voidpublic

CifValidationResultHtmlWriter Class

Summary

public class CifValidationResultHtmlWriter

.

Constructor Members

NameAccessSummary
CifValidationResultHtmlWriter()publicInitializes a new instance of the class.
CifValidationResultHtmlWriter()public
CifValidationResultHtmlWriter()public
CifValidationResultHtmlWriter()public

Property Members

NameAccessSummary
Target : TextWriterpublic

Method Members

NameAccessSummary
Close() : Voidpublic
Flush() : Voidpublic
Write() : Voidpublic
Write() : Voidpublic

CifValidationConsoleWriter Class

Summary

public class CifValidationConsoleWriter : AStar.Cif.ICifValidationHandler

.

Constructor Members

NameAccessSummary
CifValidationConsoleWriter()publicInitializes a new instance of the class.

Property Members

NameAccessSummary
ColorForError : ConsoleColorpublic .
ColorForMessage : ConsoleColorpublic .
IsValid : Booleanpublic
UseColors : Booleanpublic .

Method Members

NameAccessSummary
OnError() : Voidpublic
OnMessage() : Voidpublic

CifValidationError Class

Summary

public class CifValidationError

.

Constructor Members

NameAccessSummary
CifValidationError()public
CifValidationError()public

Property Members

NameAccessSummary
Arguments : Object[]public
Code : Int32public
Description : Stringpublic

Method Members

NameAccessSummary

CifDictionaryException Class

Summary

public class CifDictionaryException : Exception, System.Runtime.Serialization.ISerializable

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifDictionaryException()publicInitializes a new instance of the class.
CifDictionaryException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary

CifPackWriter Class

Summary

public class CifPackWriter

A writer that provides a way to write CifPack objects to streams or files.

Constructor Members

NameAccessSummary
CifPackWriter()public Creates a new CifPackWriter instance.
CifPackWriter()public Creates a new CifPackWriter instance.
CifPackWriter()public Creates a new CifPackWriter instance.

Field Members

NameAccessSummary
BlockIndent : Int32public
ColumnLimit : Int32public .
DefaultBlank : Charpublic
Error_ColumnLimit : Int32public
Error_InvalidName : Int32public
Error_InvalidTag : Int32public
Error_InvalidValue : Int32public
Error_LoopNotIntegral : Int32public
Error_NameLimit : Int32public
ErrorCountLimit : Int32public Maximum allowed number of errors, CifPackWriter will abort the Write process and throw a CPWException when this limit is exceeded.
FrameIndent : Int32public
IndentChar : Charpublic
LoopIndent : Int32public
NameLimit : Int32public .
NewLine : Stringpublic The newline string.

Property Members

NameAccessSummary
ErrorCount : Int32public The error count.
ErrorList : CifPWError[]public The error information list.
Indent : Int32public The current indentation level.

Method Members

NameAccessSummary
BslEolEscape() : Stringpublic
BslEolEscapeLine() : Stringpublic
BslEolUnescape() : Stringpublic
Close() : Voidpublic Closes the target writer.
Flush() : Voidpublic Flushs the target writer.
SetTarget() : Voidpublic Sets the target.
SetTarget() : Voidpublic Sets the target.
Write() : Voidpublic Writes a CifBlock.
Write() : Voidpublic Writes a CifPack.

CifPWException Class

Summary

public class CifPWException : Exception, System.Runtime.Serialization.ISerializable

.

This type has the following attributes: System.SerializableAttribute

Constructor Members

NameAccessSummary
CifPWException()public
CifPWException()public

Property Members

NameAccessSummary
ErrorList : CifPWError[]public

Method Members

NameAccessSummary

CifPWError Class

Summary

public class CifPWError

.

Constructor Members

NameAccessSummary
CifPWError()public
CifPWError()public

Field Members

NameAccessSummary
EColumn : Int32public
ELine : Int32public
SColumn : Int32public
SLine : Int32public

Property Members

NameAccessSummary
Code : Int32public Error code.
Column : Int32public Column number, 1-based.
Description : Stringpublic Error details.
Line : Int32public Line number, 1-based.

Method Members

NameAccessSummary

CifPackReader Class

Summary

public class CifPackReader

A reader that creates CifPack objects from the CIF streams or files.

Constructor Members

NameAccessSummary
CifPackReader()public Creates a new CifPackReader instance.
CifPackReader()public Creates a new CifPackReader instance.
CifPackReader()public Creates a new CifPackReader instance.

Field Members

NameAccessSummary
ColumnLimit : Int32public .
ErrorCountLimit : Int32public 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 : Int32public .
NewLine : Stringpublic .
NormalizeNewLines : Booleanpublic .

Property Members

NameAccessSummary
ErrorCount : Int32public Count of errors, non-zero if there are syntactic/semantic errors.
ErrorList : CifPRError[]public A detailed error information list.

Method Members

NameAccessSummary
Close() : Voidpublic Closes the reader instance and the underlying source stream.
Read() : CifPackpublic Reads a CifPack object from the source.
Read() : CifPackpublic Reads a CifPack object from the source.
SetSource() : Voidpublic Sets the source stream.
SetSource() : Voidpublic Sets the source stream.
SetSourceText() : Voidpublic 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

NameAccessSummary
CifPRException()public
CifPRException()public

Property Members

NameAccessSummary
ErrorList : CifPRError[]public .

Method Members

NameAccessSummary

CifPRError Class

Summary

public class CifPRError

.

Constructor Members

NameAccessSummary
CifPRError()public
CifPRError()public

Field Members

NameAccessSummary
EColumn : Int32public
ELine : Int32public
SColumn : Int32public
SLine : Int32public

Property Members

NameAccessSummary
Code : Int32public Error code.
Column : Int32public Column number.
Description : Stringpublic Error details.
Line : Int32public Line number.

Method Members

NameAccessSummary

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

NameAccessSummary
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

NameAccessSummary
ColumnLimit : Int32public .
IgnoreScannerErrors : Booleanpublic .
NameLimit : Int32public .
NewLine : Stringpublic .
NormalizeNewLines : Booleanpublic .

Property Members

NameAccessSummary
Column : Int32public The current column number.
ContentType : CifContentTypepublic The type of the data in the reader.
EOF : Booleanpublic Indicates whether the reader is at the end of the source (file).
Line : Int32public The current line number.
Name : Stringpublic The name of the current primitive field / loop field / block / frame.
Names : String[]public The field names of the current loop.
ReadState : CifTextReadStatepublic The read state of the reader instance.
Value : Stringpublic The value of the current primitive field / loop field / comment.

Method Members

NameAccessSummary
Close() : Voidpublic Closes the reader instance and the underlying source stream.
Read() : Booleanpublic Reads the next item.
ResetState() : Voidpublic Resets the state of the reader instance.
SetSource() : Voidpublic Sets the source stream.
SetSource() : Voidpublic Sets the source stream.
SetSourceText() : Voidpublic 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

NameAccessSummary
CifTRException()publicInitializes a new instance of the class.
CifTRException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary

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

NameAccessSummary
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

NameAccessSummary
BlockIndent : Int32public .
ColumnLimit : Int32public .
DefaultBlank : Charpublic .
FrameIndent : Int32public .
IndentChar : Charpublic .
LoopIndent : Int32public .
NameLimit : Int32public .
NewLine : Stringpublic The newline string.

Property Members

NameAccessSummary
Indent : Int32public The current indentation level.
WriteState : CifTextWriteStatepublic The write state.

Method Members

NameAccessSummary
Close() : Voidpublic Closes the CifTextWriter instance and the underlying target TextWriter instance.
Flush() : Voidpublic Flushes the target.
SetTarget() : Voidpublic Sets the target.
SetTarget() : Voidpublic Sets the target.
WriteBlock() : Voidpublic Writes a data block with the name.
WriteComment() : Voidpublic Writes a comment.
WriteComment() : Voidpublic Writes a comment.
WriteEndFrame() : Voidpublic Writes the end of a save frame.
WriteEndLoop() : Voidpublic Writes the end of a data loop, (check the integrity and end the LOOP state).
WriteField() : Voidpublic Fills a data loop field with the value.
WriteField() : Voidpublic Fills a data loop field with the value, in the specified literal form if possible.
WriteField() : Voidpublic Writes a primitive data field with the name and value pair.
WriteField() : Voidpublic Writes a primitive data field with the name and value, in the specified literal form if possible.
WriteFrame() : Voidpublic Writes a save frame with the name.
WriteLoop() : Voidpublic Writes a data loop with the field names.
WriteLoop() : Voidpublic Writes a data loop with the field names.
WriteNewLine() : Voidpublic 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

NameAccessSummary
CifTWException()publicInitializes a new instance of the class.
CifTWException()public

Property Members

NameAccessSummary

Method Members

NameAccessSummary