ch.ninecode.model.CongestionRevenueRights.scala Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of CIMReader Show documentation
Show all versions of CIMReader Show documentation
Expose CIM data files as Spark RDD
package ch.ninecode.model
import com.esotericsoftware.kryo.Kryo
import com.esotericsoftware.kryo.Serializer
import com.esotericsoftware.kryo.io.Input
import com.esotericsoftware.kryo.io.Output
import org.apache.spark.sql.Row
import ch.ninecode.cim.CIMClassInfo
import ch.ninecode.cim.CIMContext
import ch.ninecode.cim.CIMParseable
import ch.ninecode.cim.CIMRelationship
import ch.ninecode.cim.CIMSerializer
/**
* Identifies a way in which an organisation may participate with a defined Congestion Revenue Right (CRR).
*
* @param OrganisationRole [[ch.ninecode.model.OrganisationRole OrganisationRole]] Reference to the superclass object.
* @param kind Kind of role the organisation is with regards to the congestion revenue rights.
* @param status Status of congestion revenue rights organisation role.
* @param CongestionRevenueRight [[ch.ninecode.model.CongestionRevenueRight CongestionRevenueRight]] undocumented
* @group CongestionRevenueRights
* @groupname CongestionRevenueRights Package CongestionRevenueRights
* @groupdesc CongestionRevenueRights Congestion rent is a major, highly volatile charge currently faced by many participants in the LMP-based electrical energy markets. For this reason, the ISOs offer congestion revenue rights (CRR), also known as financial transmission rights or transmission congestion contracts. These are financial instruments that allow market participants to hedge against congestion charges when they schedule their generation, load and bilateral energy transactions.
*/
final case class CRROrgRole
(
OrganisationRole: OrganisationRole = null,
kind: String = null,
status: String = null,
CongestionRevenueRight: String = null
)
extends
Element
{
/**
* Return the superclass object.
*
* @return The typed superclass nested object.
* @group Hierarchy
* @groupname Hierarchy Class Hierarchy Related
* @groupdesc Hierarchy Members related to the nested hierarchy of CIM classes.
*/
override def sup: OrganisationRole = OrganisationRole
//
// Row overrides
//
/**
* Return a copy of this object as a Row.
*
* Creates a clone of this object for use in Row manipulations.
*
* @return The copy of the object.
* @group Row
* @groupname Row SQL Row Implementation
* @groupdesc Row Members related to implementing the SQL Row interface
*/
override def copy (): Row = { clone ().asInstanceOf[Row] }
override def export_fields: String =
{
implicit val s: StringBuilder = new StringBuilder (sup.export_fields)
implicit val clz: String = CRROrgRole.cls
def emitattr (position: Int, value: Any): Unit = if (mask (position)) emit_attribute (CRROrgRole.fields (position), value)
emitattr (0, kind)
emitattr (1, status)
emitattr (2, CongestionRevenueRight)
s.toString
}
override def export: String =
{
"\t\n%s\t ".format (id, export_fields)
}
}
object CRROrgRole
extends
CIMParseable[CRROrgRole]
{
override val fields: Array[String] = Array[String] (
"kind",
"status",
"CongestionRevenueRight"
)
override val relations: List[CIMRelationship] = List (
CIMRelationship ("CongestionRevenueRight", "CongestionRevenueRight", "1", "1..*")
)
val kind: Fielder = parse_attribute (attribute (cls, fields(0)))
val status: Fielder = parse_attribute (attribute (cls, fields(1)))
val CongestionRevenueRight: Fielder = parse_attribute (attribute (cls, fields(2)))
def parse (context: CIMContext): CRROrgRole =
{
implicit val ctx: CIMContext = context
implicit val bitfields: Array[Int] = Array(0)
val ret = CRROrgRole (
OrganisationRole.parse (context),
mask (kind (), 0),
mask (status (), 1),
mask (CongestionRevenueRight (), 2)
)
ret.bitfields = bitfields
ret
}
def serializer: Serializer[CRROrgRole] = CRROrgRoleSerializer
}
object CRROrgRoleSerializer extends CIMSerializer[CRROrgRole]
{
def write (kryo: Kryo, output: Output, obj: CRROrgRole): Unit =
{
val toSerialize: Array[() => Unit] = Array (
() => output.writeString (obj.kind),
() => output.writeString (obj.status),
() => output.writeString (obj.CongestionRevenueRight)
)
OrganisationRoleSerializer.write (kryo, output, obj.sup)
implicit val bitfields: Array[Int] = obj.bitfields
writeBitfields (output)
writeFields (toSerialize)
}
def read (kryo: Kryo, input: Input, cls: Class[CRROrgRole]): CRROrgRole =
{
val parent = OrganisationRoleSerializer.read (kryo, input, classOf[OrganisationRole])
implicit val bitfields: Array[Int] = readBitfields (input)
val obj = CRROrgRole (
parent,
if (isSet (0)) input.readString else null,
if (isSet (1)) input.readString else null,
if (isSet (2)) input.readString else null
)
obj.bitfields = bitfields
obj
}
}
/**
* CRRSegment represents a segment of a CRR in a particular time frame.
*
* The segment class contains amount, clearing price, start date and time, end date and time.
*
* @param IdentifiedObject [[ch.ninecode.model.IdentifiedObject IdentifiedObject]] Reference to the superclass object.
* @param amount Dollar amount = quantity x clearingPrice
* @param clearingPrice Clearing price of a CRR
* @param endDateTime segment end date time
* @param quantity The MW amount associated with the CRR
* @param startDateTime segment start date time
* @param CongestionRevenueRight [[ch.ninecode.model.CongestionRevenueRight CongestionRevenueRight]] undocumented
* @param Sink [[ch.ninecode.model.Pnode Pnode]] undocumented
* @param Source [[ch.ninecode.model.Pnode Pnode]] undocumented
* @group CongestionRevenueRights
* @groupname CongestionRevenueRights Package CongestionRevenueRights
* @groupdesc CongestionRevenueRights Congestion rent is a major, highly volatile charge currently faced by many participants in the LMP-based electrical energy markets. For this reason, the ISOs offer congestion revenue rights (CRR), also known as financial transmission rights or transmission congestion contracts. These are financial instruments that allow market participants to hedge against congestion charges when they schedule their generation, load and bilateral energy transactions.
*/
final case class CRRSegment
(
IdentifiedObject: IdentifiedObject = null,
amount: Double = 0.0,
clearingPrice: Double = 0.0,
endDateTime: String = null,
quantity: Double = 0.0,
startDateTime: String = null,
CongestionRevenueRight: String = null,
Sink: List[String] = null,
Source: List[String] = null
)
extends
Element
{
/**
* Return the superclass object.
*
* @return The typed superclass nested object.
* @group Hierarchy
* @groupname Hierarchy Class Hierarchy Related
* @groupdesc Hierarchy Members related to the nested hierarchy of CIM classes.
*/
override def sup: IdentifiedObject = IdentifiedObject
//
// Row overrides
//
/**
* Return a copy of this object as a Row.
*
* Creates a clone of this object for use in Row manipulations.
*
* @return The copy of the object.
* @group Row
* @groupname Row SQL Row Implementation
* @groupdesc Row Members related to implementing the SQL Row interface
*/
override def copy (): Row = { clone ().asInstanceOf[Row] }
override def export_fields: String =
{
implicit val s: StringBuilder = new StringBuilder (sup.export_fields)
implicit val clz: String = CRRSegment.cls
def emitelem (position: Int, value: Any): Unit = if (mask (position)) emit_element (CRRSegment.fields (position), value)
def emitattr (position: Int, value: Any): Unit = if (mask (position)) emit_attribute (CRRSegment.fields (position), value)
def emitattrs (position: Int, value: List[String]): Unit = if (mask (position) && (null != value)) value.foreach (x => emit_attribute (CRRSegment.fields (position), x))
emitelem (0, amount)
emitelem (1, clearingPrice)
emitelem (2, endDateTime)
emitelem (3, quantity)
emitelem (4, startDateTime)
emitattr (5, CongestionRevenueRight)
emitattrs (6, Sink)
emitattrs (7, Source)
s.toString
}
override def export: String =
{
"\t\n%s\t ".format (id, export_fields)
}
}
object CRRSegment
extends
CIMParseable[CRRSegment]
{
override val fields: Array[String] = Array[String] (
"amount",
"clearingPrice",
"endDateTime",
"quantity",
"startDateTime",
"CongestionRevenueRight",
"Sink",
"Source"
)
override val relations: List[CIMRelationship] = List (
CIMRelationship ("CongestionRevenueRight", "CongestionRevenueRight", "1", "1..*"),
CIMRelationship ("Sink", "Pnode", "0..*", "0..*"),
CIMRelationship ("Source", "Pnode", "0..*", "0..*")
)
val amount: Fielder = parse_element (element (cls, fields(0)))
val clearingPrice: Fielder = parse_element (element (cls, fields(1)))
val endDateTime: Fielder = parse_element (element (cls, fields(2)))
val quantity: Fielder = parse_element (element (cls, fields(3)))
val startDateTime: Fielder = parse_element (element (cls, fields(4)))
val CongestionRevenueRight: Fielder = parse_attribute (attribute (cls, fields(5)))
val Sink: FielderMultiple = parse_attributes (attribute (cls, fields(6)))
val Source: FielderMultiple = parse_attributes (attribute (cls, fields(7)))
def parse (context: CIMContext): CRRSegment =
{
implicit val ctx: CIMContext = context
implicit val bitfields: Array[Int] = Array(0)
val ret = CRRSegment (
IdentifiedObject.parse (context),
toDouble (mask (amount (), 0)),
toDouble (mask (clearingPrice (), 1)),
mask (endDateTime (), 2),
toDouble (mask (quantity (), 3)),
mask (startDateTime (), 4),
mask (CongestionRevenueRight (), 5),
masks (Sink (), 6),
masks (Source (), 7)
)
ret.bitfields = bitfields
ret
}
def serializer: Serializer[CRRSegment] = CRRSegmentSerializer
}
object CRRSegmentSerializer extends CIMSerializer[CRRSegment]
{
def write (kryo: Kryo, output: Output, obj: CRRSegment): Unit =
{
val toSerialize: Array[() => Unit] = Array (
() => output.writeDouble (obj.amount),
() => output.writeDouble (obj.clearingPrice),
() => output.writeString (obj.endDateTime),
() => output.writeDouble (obj.quantity),
() => output.writeString (obj.startDateTime),
() => output.writeString (obj.CongestionRevenueRight),
() => writeList (obj.Sink, output),
() => writeList (obj.Source, output)
)
IdentifiedObjectSerializer.write (kryo, output, obj.sup)
implicit val bitfields: Array[Int] = obj.bitfields
writeBitfields (output)
writeFields (toSerialize)
}
def read (kryo: Kryo, input: Input, cls: Class[CRRSegment]): CRRSegment =
{
val parent = IdentifiedObjectSerializer.read (kryo, input, classOf[IdentifiedObject])
implicit val bitfields: Array[Int] = readBitfields (input)
val obj = CRRSegment (
parent,
if (isSet (0)) input.readDouble else 0.0,
if (isSet (1)) input.readDouble else 0.0,
if (isSet (2)) input.readString else null,
if (isSet (3)) input.readDouble else 0.0,
if (isSet (4)) input.readString else null,
if (isSet (5)) input.readString else null,
if (isSet (6)) readList (input) else null,
if (isSet (7)) readList (input) else null
)
obj.bitfields = bitfields
obj
}
}
/**
* Congestion Revenue Rights (CRR) class that is inherited from a Document class.
*
* A CRR is a financial concept that is used to hedge congestion charges.
*
* The CRR is usually settled based on the Locational Marginal Prices (LMPs) that are calculated in the day-ahead market. These LMPs are determined by the Day-ahead resource schedules/bids. CRRs will not hedge against marginal losses. If the congestion component of LMP at the sink is greater than at the source, then the CRR owner is entitled to receive a portion of congestion revenues. If the congestion component at the sink is less than at the source, then an obligation-type CRR owner will be charged, but an option-type CRR owner will not.
*
* @param Document [[ch.ninecode.model.Document Document]] Reference to the superclass object.
* @param cRRcategory CRR category represents 'PTP' for a point-to-point CRR, or 'NSR' for a Network Service Right.
* If CRR category is 'PTP', both Source ID and Sink ID fields are required. If CRR category is 'NSR' only one field, either Source ID or Sink ID, shall be not null and the other shall be null. However, the 'NSR' category will include at least three records.
* @param cRRtype Type of the CRR, from the possible type definitions in the CRR System (e.g. 'LSE', 'ETC').
* @param hedgeType Hedge type Obligation or Option.
* An obligation type requires the holder to receive or pay the congestion rent. An option type gives the holder the option of receiving or paying the congestion rent.
* @param timeOfUse Time of Use flag of the CRR - Peak (ON), Offpeak (OFF) or all 24 hours (24HR).
* @param tradeSliceID Segment of the CRR described in the current record.
* @param CRRMarket [[ch.ninecode.model.CRRMarket CRRMarket]] undocumented
* @param CRROrgRole [[ch.ninecode.model.CRROrgRole CRROrgRole]] undocumented
* @param CRRSegment [[ch.ninecode.model.CRRSegment CRRSegment]] undocumented
* @param Flowgate [[ch.ninecode.model.Flowgate Flowgate]] undocumented
* @group CongestionRevenueRights
* @groupname CongestionRevenueRights Package CongestionRevenueRights
* @groupdesc CongestionRevenueRights Congestion rent is a major, highly volatile charge currently faced by many participants in the LMP-based electrical energy markets. For this reason, the ISOs offer congestion revenue rights (CRR), also known as financial transmission rights or transmission congestion contracts. These are financial instruments that allow market participants to hedge against congestion charges when they schedule their generation, load and bilateral energy transactions.
*/
final case class CongestionRevenueRight
(
Document: Document = null,
cRRcategory: String = null,
cRRtype: String = null,
hedgeType: String = null,
timeOfUse: String = null,
tradeSliceID: String = null,
CRRMarket: String = null,
CRROrgRole: List[String] = null,
CRRSegment: List[String] = null,
Flowgate: String = null
)
extends
Element
{
/**
* Return the superclass object.
*
* @return The typed superclass nested object.
* @group Hierarchy
* @groupname Hierarchy Class Hierarchy Related
* @groupdesc Hierarchy Members related to the nested hierarchy of CIM classes.
*/
override def sup: Document = Document
//
// Row overrides
//
/**
* Return a copy of this object as a Row.
*
* Creates a clone of this object for use in Row manipulations.
*
* @return The copy of the object.
* @group Row
* @groupname Row SQL Row Implementation
* @groupdesc Row Members related to implementing the SQL Row interface
*/
override def copy (): Row = { clone ().asInstanceOf[Row] }
override def export_fields: String =
{
implicit val s: StringBuilder = new StringBuilder (sup.export_fields)
implicit val clz: String = CongestionRevenueRight.cls
def emitelem (position: Int, value: Any): Unit = if (mask (position)) emit_element (CongestionRevenueRight.fields (position), value)
def emitattr (position: Int, value: Any): Unit = if (mask (position)) emit_attribute (CongestionRevenueRight.fields (position), value)
def emitattrs (position: Int, value: List[String]): Unit = if (mask (position) && (null != value)) value.foreach (x => emit_attribute (CongestionRevenueRight.fields (position), x))
emitattr (0, cRRcategory)
emitattr (1, cRRtype)
emitattr (2, hedgeType)
emitattr (3, timeOfUse)
emitelem (4, tradeSliceID)
emitattr (5, CRRMarket)
emitattrs (6, CRROrgRole)
emitattrs (7, CRRSegment)
emitattr (8, Flowgate)
s.toString
}
override def export: String =
{
"\t\n%s\t ".format (id, export_fields)
}
}
object CongestionRevenueRight
extends
CIMParseable[CongestionRevenueRight]
{
override val fields: Array[String] = Array[String] (
"cRRcategory",
"cRRtype",
"hedgeType",
"timeOfUse",
"tradeSliceID",
"CRRMarket",
"CRROrgRole",
"CRRSegment",
"Flowgate"
)
override val relations: List[CIMRelationship] = List (
CIMRelationship ("CRRMarket", "CRRMarket", "1", "1..*"),
CIMRelationship ("CRROrgRole", "CRROrgRole", "1..*", "1"),
CIMRelationship ("CRRSegment", "CRRSegment", "1..*", "1"),
CIMRelationship ("Flowgate", "Flowgate", "0..1", "0..1")
)
val cRRcategory: Fielder = parse_attribute (attribute (cls, fields(0)))
val cRRtype: Fielder = parse_attribute (attribute (cls, fields(1)))
val hedgeType: Fielder = parse_attribute (attribute (cls, fields(2)))
val timeOfUse: Fielder = parse_attribute (attribute (cls, fields(3)))
val tradeSliceID: Fielder = parse_element (element (cls, fields(4)))
val CRRMarket: Fielder = parse_attribute (attribute (cls, fields(5)))
val CRROrgRole: FielderMultiple = parse_attributes (attribute (cls, fields(6)))
val CRRSegment: FielderMultiple = parse_attributes (attribute (cls, fields(7)))
val Flowgate: Fielder = parse_attribute (attribute (cls, fields(8)))
def parse (context: CIMContext): CongestionRevenueRight =
{
implicit val ctx: CIMContext = context
implicit val bitfields: Array[Int] = Array(0)
val ret = CongestionRevenueRight (
Document.parse (context),
mask (cRRcategory (), 0),
mask (cRRtype (), 1),
mask (hedgeType (), 2),
mask (timeOfUse (), 3),
mask (tradeSliceID (), 4),
mask (CRRMarket (), 5),
masks (CRROrgRole (), 6),
masks (CRRSegment (), 7),
mask (Flowgate (), 8)
)
ret.bitfields = bitfields
ret
}
def serializer: Serializer[CongestionRevenueRight] = CongestionRevenueRightSerializer
}
object CongestionRevenueRightSerializer extends CIMSerializer[CongestionRevenueRight]
{
def write (kryo: Kryo, output: Output, obj: CongestionRevenueRight): Unit =
{
val toSerialize: Array[() => Unit] = Array (
() => output.writeString (obj.cRRcategory),
() => output.writeString (obj.cRRtype),
() => output.writeString (obj.hedgeType),
() => output.writeString (obj.timeOfUse),
() => output.writeString (obj.tradeSliceID),
() => output.writeString (obj.CRRMarket),
() => writeList (obj.CRROrgRole, output),
() => writeList (obj.CRRSegment, output),
() => output.writeString (obj.Flowgate)
)
DocumentSerializer.write (kryo, output, obj.sup)
implicit val bitfields: Array[Int] = obj.bitfields
writeBitfields (output)
writeFields (toSerialize)
}
def read (kryo: Kryo, input: Input, cls: Class[CongestionRevenueRight]): CongestionRevenueRight =
{
val parent = DocumentSerializer.read (kryo, input, classOf[Document])
implicit val bitfields: Array[Int] = readBitfields (input)
val obj = CongestionRevenueRight (
parent,
if (isSet (0)) input.readString else null,
if (isSet (1)) input.readString else null,
if (isSet (2)) input.readString else null,
if (isSet (3)) input.readString else null,
if (isSet (4)) input.readString else null,
if (isSet (5)) input.readString else null,
if (isSet (6)) readList (input) else null,
if (isSet (7)) readList (input) else null,
if (isSet (8)) input.readString else null
)
obj.bitfields = bitfields
obj
}
}
private[ninecode] object _CongestionRevenueRights
{
def register: List[CIMClassInfo] =
{
List (
CRROrgRole.register,
CRRSegment.register,
CongestionRevenueRight.register
)
}
}