Class NcBinaryType
A data type for a digital representation of an object encoded in a binary format.
Implements
Inherited Members
Namespace: NiemTypes
Assembly: EidoLib.dll
Syntax
[DataContract]
public class NcBinaryType : IEquatable<NcBinaryType>
Properties
Augmentation
Additional information about a binary. NIEM reference is j:BinaryAugmentation
Declaration
[DataMember(Name = "augmentation")]
public List<JBinaryAugmentationType> Augmentation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<JBinaryAugmentationType> | Additional information about a binary. NIEM reference is j:BinaryAugmentation |
Base64Object
A base64 binary encoding of data. NIEM reference is nc:Base64BinaryObject
Declaration
[DataMember(Name = "base64Object")]
public List<NiemXsbase64Binary> Base64Object { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsbase64Binary> | A base64 binary encoding of data. NIEM reference is nc:Base64BinaryObject |
BinaryId
An identifier that references a binary object. NIEM reference is nc:BinaryID
Declaration
[DataMember(Name = "binaryId")]
public List<NiemXsstring> BinaryId { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsstring> | An identifier that references a binary object. NIEM reference is nc:BinaryID |
CaptureDate
A date on which a binary object is captured or created. NIEM reference is nc:BinaryCaptureDate
Declaration
[DataMember(Name = "captureDate")]
public List<NcDateType> CaptureDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date on which a binary object is captured or created. NIEM reference is nc:BinaryCaptureDate |
Capturer
An entity which captured or created a binary object. NIEM reference is nc:BinaryCapturer
Declaration
[DataMember(Name = "capturer")]
public List<NcEntityType> Capturer { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | An entity which captured or created a binary object. NIEM reference is nc:BinaryCapturer |
Category
A kind of object that has been encoded. NIEM reference is nc:BinaryCategoryText
Declaration
[DataMember(Name = "category")]
public List<NcTextType> Category { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A kind of object that has been encoded. NIEM reference is nc:BinaryCategoryText |
CategoryCode
A kind of binary object. NIEM reference is j:BinaryCategoryCode
Declaration
[DataMember(Name = "categoryCode")]
public List<NdexBinaryCategoryCodeType> CategoryCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NdexBinaryCategoryCodeType> | A kind of binary object. NIEM reference is j:BinaryCategoryCode |
Context
ncBinaryType JSON-LD context
Declaration
[DataMember(Name = "@context")]
public NcBinaryType.ContextEnum? Context { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<NcBinaryType.ContextEnum> | ncBinaryType JSON-LD context |
Description
A description of a binary object. NIEM reference is nc:BinaryDescriptionText
Declaration
[DataMember(Name = "description")]
public List<NcTextType> Description { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A description of a binary object. NIEM reference is nc:BinaryDescriptionText |
Format
A file format or content type of a binary object. NIEM reference is nc:BinaryFormatText
Declaration
[DataMember(Name = "format")]
public List<NcTextType> Format { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A file format or content type of a binary object. NIEM reference is nc:BinaryFormatText |
FormatStandardName
A name of a standard or protocol used to classify binary content. NIEM reference is nc:BinaryFormatStandardName
Declaration
[DataMember(Name = "formatStandardName")]
public List<NcTextType> FormatStandardName { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A name of a standard or protocol used to classify binary content. NIEM reference is nc:BinaryFormatStandardName |
Hash
A hash value representing an object encoded in a binary format. NIEM reference is nc:BinaryHash
Declaration
[DataMember(Name = "hash")]
public List<NcBinaryHashType> Hash { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcBinaryHashType> | A hash value representing an object encoded in a binary format. NIEM reference is nc:BinaryHash |
HexObject
A hexadecimal binary encoding of data. NIEM reference is nc:HexBinaryObject
Declaration
[DataMember(Name = "hexObject")]
public List<NiemXshexBinary> HexObject { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXshexBinary> | A hexadecimal binary encoding of data. NIEM reference is nc:HexBinaryObject |
IsAvailable
True if a binary is available; false if it is not. NIEM reference is nc:BinaryAvailableIndicator
Declaration
[DataMember(Name = "isAvailable")]
public List<NiemXsboolean> IsAvailable { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a binary is available; false if it is not. NIEM reference is nc:BinaryAvailableIndicator |
Location
A physical location of a binary object. NIEM reference is nc:BinaryLocationText
Declaration
[DataMember(Name = "location")]
public List<NcTextType> Location { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A physical location of a binary object. NIEM reference is nc:BinaryLocationText |
SizeValue
A size of a binary object in kilobytes. NIEM reference is nc:BinarySizeValue
Declaration
[DataMember(Name = "sizeValue")]
public List<NcNonNegativeDecimalType> SizeValue { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcNonNegativeDecimalType> | A size of a binary object in kilobytes. NIEM reference is nc:BinarySizeValue |
Uri
A URL or file reference of a binary object. NIEM reference is nc:BinaryURI
Declaration
[DataMember(Name = "uri")]
public List<NiemXsanyURI> Uri { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsanyURI> | A URL or file reference of a binary object. NIEM reference is nc:BinaryURI |
Utf8Object
A UTF8 binary encoding of data. NIEM reference is cbrn:UTF8BinaryObjectText
Declaration
[DataMember(Name = "utf8Object")]
public List<NiemXsstring> Utf8Object { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsstring> | A UTF8 binary encoding of data. NIEM reference is cbrn:UTF8BinaryObjectText |
Methods
Equals(NcBinaryType)
Returns true if NcBinaryType instances are equal
Declaration
public bool Equals(NcBinaryType other)
Parameters
Type | Name | Description |
---|---|---|
NcBinaryType | other | Instance of NcBinaryType to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | Object to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Hash code |
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String presentation of the object |
Overrides
Operators
Equality(NcBinaryType, NcBinaryType)
Declaration
public static bool operator ==(NcBinaryType left, NcBinaryType right)
Parameters
Type | Name | Description |
---|---|---|
NcBinaryType | left | |
NcBinaryType | right |
Returns
Type | Description |
---|---|
System.Boolean |
Inequality(NcBinaryType, NcBinaryType)
Declaration
public static bool operator !=(NcBinaryType left, NcBinaryType right)
Parameters
Type | Name | Description |
---|---|---|
NcBinaryType | left | |
NcBinaryType | right |
Returns
Type | Description |
---|---|
System.Boolean |