cim1.model

Class GeneratingUnit

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Equipment

cim1.model.GeneratingUnit

Direct Known Subclasses:

HydroGeneratingUnit, NuclearGeneratingUnit, ThermalGeneratingUnit, WindGeneratingUnit

public class GeneratingUnit
extends Equipment

This file has been automatically generated by CIMGateway Description : This class "GeneratingUnit.java" represents the class GeneratingUnit extends Equipment + ControlAreaGeneratingUnit 0..-1 ControlAreaGeneratingUnit (inverseAssociation) + variableCost 0..1 float + normalPF 0..1 float + governorSCD 0..1 float + nominalP 1..1 float + startupCost 0..1 float + maximumAllowableSpinningReserve 0..1 float + minOperatingP 1..1 float + maxOperatingP 1..1 float + Contains_SynchronousMachines 0..-1 SynchronousMachine (inverseAssociation)

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<SynchronousMachine>	contains_SynchronousMachines Attribute "contains_SynchronousMachines" Comment from profile: A synchronous machine may operate as a generator and as such becomes a member of a generating unit
java.util.List<ControlAreaGeneratingUnit>	controlAreaGeneratingUnit Attribute "controlAreaGeneratingUnit" Comment from profile: ControlArea specifications for this generating unit.
float	governorSCD Attribute "governorSCD" Comment from profile: Governor Speed Changer Droop.
float	maximumAllowableSpinningReserve Attribute "maximumAllowableSpinningReserve" Comment from profile: Maximum allowable spinning reserve.
float	maxOperatingP Attribute "maxOperatingP" Comment from profile: This is the maximum operating active power limit the dispatcher can enter for this unit
float	minOperatingP Attribute "minOperatingP" Comment from profile: This is the minimum operating active power limit the dispatcher can enter for this unit.
float	nominalP Attribute "nominalP" Comment from profile: The nominal power of the generating unit.
float	normalPF Attribute "normalPF" Comment from profile:
float	startupCost Attribute "startupCost" Comment from profile: The initial startup cost incurred for each start of the GeneratingUnit.This is for Short Circuit only.
float	variableCost Attribute "variableCost" Comment from profile: The variable cost component of production per unit of ActivePower.This is for Short Circuit only.

Fields inherited from class cim1.model.Equipment

equivalent, idMemberOf_EquipmentContainer, memberOf_EquipmentContainer

Fields inherited from class cim1.model.IdentifiedObject

aliasName, description, name

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeneratingUnit() Constructor of the class GeneratingUnit

Method Summary

Modifier and Type	Method and Description
void	addContains_SynchronousMachines(SynchronousMachine contains_SynchronousMachinesValue, boolean setInverse) Utility to add a value within the "contains_SynchronousMachines" ArrayList of "SynchronousMachine"
void	addControlAreaGeneratingUnit(ControlAreaGeneratingUnit controlAreaGeneratingUnitValue, boolean setInverse) Utility to add a value within the "controlAreaGeneratingUnit" ArrayList of "ControlAreaGeneratingUnit"
protected void	clearAssociations(Subset subset) Utility to clear the associations of this class belonging to a specific subset
void	clearContent(Subset subset) Utility to "clear" the content of a class when a subset is invalidated
GeneratingUnit	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
boolean	contains_SynchronousMachinesIsSet() Utility to test if the value of "contains_SynchronousMachines" has been set
boolean	controlAreaGeneratingUnitIsSet() Utility to test if the value of "controlAreaGeneratingUnit" has been set
void	copyBase(GeneratingUnit otherGeneratingUnit) Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy
static GeneratingUnit	create(java.lang.String id) Factory of the class
java.util.List<SynchronousMachine>	getContains_SynchronousMachines() Utility to return the "contains_SynchronousMachines" List of "SynchronousMachine" enum
java.util.List<ControlAreaGeneratingUnit>	getControlAreaGeneratingUnit() Utility to return the "controlAreaGeneratingUnit" List of "ControlAreaGeneratingUnit" enum
float	getGovernorSCD() Utility to return the "governorSCD" value
float	getMaximumAllowableSpinningReserve() Utility to return the "maximumAllowableSpinningReserve" value
float	getMaxOperatingP() Utility to return the "maxOperatingP" value
float	getMinOperatingP() Utility to return the "minOperatingP" value
float	getNominalP() Utility to return the "nominalP" value
float	getNormalPF() Utility to return the "normalPF" value
float	getStartupCost() Utility to return the "startupCost" value
float	getVariableCost() Utility to return the "variableCost" value
boolean	governorSCDIsSet() Utility to test if the value of "governorSCD" has been set
boolean	maximumAllowableSpinningReserveIsSet() Utility to test if the value of "maximumAllowableSpinningReserve" has been set
boolean	maxOperatingPIsSet() Utility to test if the value of "maxOperatingP" has been set
boolean	minOperatingPIsSet() Utility to test if the value of "minOperatingP" has been set
ConsistencyCheck	modelConsistency() Utility to check whether this class is consistent in a "merged" context
ConsistencyCheck	modelConsistency(Subset subset) Utility to check whether this class is consistent according to a subset
boolean	nominalPIsSet() Utility to test if the value of "nominalP" has been set
boolean	normalPFIsSet() Utility to test if the value of "normalPF" has been set
void	readAttribute(java.lang.String class_name, java.lang.String attr_name, java.lang.String value, CIMModel model) Utility to read an attribute This function is called by the CIMModel
void	readResource(java.lang.String class_name, java.lang.String resource_name, java.lang.String id, CIMModel model) Utility to read a reference to a resource This function is called by the CIMModel
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
void	setGovernorSCD(float governorSCDValue) Utility to set the "governorSCD" value
void	setMaximumAllowableSpinningReserve(float maximumAllowableSpinningReserveValue) Utility to set the "maximumAllowableSpinningReserve" value
void	setMaxOperatingP(float maxOperatingPValue) Utility to set the "maxOperatingP" value
void	setMinOperatingP(float minOperatingPValue) Utility to set the "minOperatingP" value
void	setNominalP(float nominalPValue) Utility to set the "nominalP" value
void	setNormalPF(float normalPFValue) Utility to set the "normalPF" value
void	setStartupCost(float startupCostValue) Utility to set the "startupCost" value
void	setVariableCost(float variableCostValue) Utility to set the "variableCost" value
boolean	startupCostIsSet() Utility to test if the value of "startupCost" has been set
boolean	variableCostIsSet() Utility to test if the value of "variableCost" has been set
void	write(javax.xml.stream.XMLStreamWriter xmlsw, boolean writeID) Utility to write the content into the CIM XML format
void	write(javax.xml.stream.XMLStreamWriter xmlsw, Subset subset, boolean writeID) Utility to write the content this class into the CIM/XML format according to a subset

Methods inherited from class cim1.model.Equipment

copyBase, equivalentIsSet, getMemberOf_EquipmentContainer, isEquivalent, memberOf_EquipmentContainerIsSet, setEquivalent, setMemberOf_EquipmentContainer

Methods inherited from class cim1.model.IdentifiedObject

aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName

Methods inherited from class cim1.model.CIMInstance

addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

controlAreaGeneratingUnit

public java.util.List<ControlAreaGeneratingUnit> controlAreaGeneratingUnit

Attribute "controlAreaGeneratingUnit" Comment from profile: ControlArea specifications for this generating unit.

variableCost

public float variableCost

Attribute "variableCost" Comment from profile: The variable cost component of production per unit of ActivePower.This is for Short Circuit only.

normalPF

public float normalPF

Attribute "normalPF" Comment from profile:

governorSCD

public float governorSCD

Attribute "governorSCD" Comment from profile: Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.This is for Short Circuit Only.

nominalP

public float nominalP

Attribute "nominalP" Comment from profile: The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the govenor speed change droop (govenorSCD attribute).

startupCost

public float startupCost

Attribute "startupCost" Comment from profile: The initial startup cost incurred for each start of the GeneratingUnit.This is for Short Circuit only.

maximumAllowableSpinningReserve

public float maximumAllowableSpinningReserve

Attribute "maximumAllowableSpinningReserve" Comment from profile: Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.

minOperatingP

public float minOperatingP

Attribute "minOperatingP" Comment from profile: This is the minimum operating active power limit the dispatcher can enter for this unit.

maxOperatingP

public float maxOperatingP

Attribute "maxOperatingP" Comment from profile: This is the maximum operating active power limit the dispatcher can enter for this unit

contains_SynchronousMachines

public java.util.List<SynchronousMachine> contains_SynchronousMachines

Attribute "contains_SynchronousMachines" Comment from profile: A synchronous machine may operate as a generator and as such becomes a member of a generating unit

Constructor Detail

GeneratingUnit

protected GeneratingUnit()

Constructor of the class GeneratingUnit

Method Detail

getControlAreaGeneratingUnit

public java.util.List<ControlAreaGeneratingUnit> getControlAreaGeneratingUnit()

Utility to return the "controlAreaGeneratingUnit" List of "ControlAreaGeneratingUnit" enum

Returns:

the list of the attributes "controlAreaGeneratingUnit"

addControlAreaGeneratingUnit

public void addControlAreaGeneratingUnit(ControlAreaGeneratingUnit controlAreaGeneratingUnitValue,
                                         boolean setInverse)
                                  throws LinkageException

Utility to add a value within the "controlAreaGeneratingUnit" ArrayList of "ControlAreaGeneratingUnit"

Parameters:

controlAreaGeneratingUnitValue - value to add within the ArrayList

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

controlAreaGeneratingUnitIsSet

public boolean controlAreaGeneratingUnitIsSet()

Utility to test if the value of "controlAreaGeneratingUnit" has been set

Returns:

boolean if true the attribute "controlAreaGeneratingUnit" is already set if false it isn't yet

getVariableCost

public float getVariableCost()

Utility to return the "variableCost" value

Returns:

the value of the attribute "variableCost"

setVariableCost

public void setVariableCost(float variableCostValue)

Utility to set the "variableCost" value

Parameters:

variableCostValue - value to set

variableCostIsSet

public boolean variableCostIsSet()

Utility to test if the value of "variableCost" has been set

Returns:

boolean if true the attribute "variableCost" is already set if false isn't yet

getNormalPF

public float getNormalPF()

Utility to return the "normalPF" value

Returns:

the value of the attribute "normalPF"

setNormalPF

public void setNormalPF(float normalPFValue)

Utility to set the "normalPF" value

Parameters:

normalPFValue - value to set

normalPFIsSet

public boolean normalPFIsSet()

Utility to test if the value of "normalPF" has been set

Returns:

boolean if true the attribute "normalPF" is already set if false isn't yet

getGovernorSCD

public float getGovernorSCD()

Utility to return the "governorSCD" value

Returns:

the value of the attribute "governorSCD"

setGovernorSCD

public void setGovernorSCD(float governorSCDValue)

Utility to set the "governorSCD" value

Parameters:

governorSCDValue - value to set

governorSCDIsSet

public boolean governorSCDIsSet()

Utility to test if the value of "governorSCD" has been set

Returns:

boolean if true the attribute "governorSCD" is already set if false isn't yet

getNominalP

public float getNominalP()

Utility to return the "nominalP" value

Returns:

the value of the attribute "nominalP"

setNominalP

public void setNominalP(float nominalPValue)

Utility to set the "nominalP" value

Parameters:

nominalPValue - value to set

nominalPIsSet

public boolean nominalPIsSet()

Utility to test if the value of "nominalP" has been set

Returns:

boolean if true the attribute "nominalP" is already set if false isn't yet

getStartupCost

public float getStartupCost()

Utility to return the "startupCost" value

Returns:

the value of the attribute "startupCost"

setStartupCost

public void setStartupCost(float startupCostValue)

Utility to set the "startupCost" value

Parameters:

startupCostValue - value to set

startupCostIsSet

public boolean startupCostIsSet()

Utility to test if the value of "startupCost" has been set

Returns:

boolean if true the attribute "startupCost" is already set if false isn't yet

getMaximumAllowableSpinningReserve

public float getMaximumAllowableSpinningReserve()

Utility to return the "maximumAllowableSpinningReserve" value

Returns:

the value of the attribute "maximumAllowableSpinningReserve"

setMaximumAllowableSpinningReserve

public void setMaximumAllowableSpinningReserve(float maximumAllowableSpinningReserveValue)

Utility to set the "maximumAllowableSpinningReserve" value

Parameters:

maximumAllowableSpinningReserveValue - value to set

maximumAllowableSpinningReserveIsSet

public boolean maximumAllowableSpinningReserveIsSet()

Utility to test if the value of "maximumAllowableSpinningReserve" has been set

Returns:

boolean if true the attribute "maximumAllowableSpinningReserve" is already set if false isn't yet

getMinOperatingP

public float getMinOperatingP()

Utility to return the "minOperatingP" value

Returns:

the value of the attribute "minOperatingP"

setMinOperatingP

public void setMinOperatingP(float minOperatingPValue)

Utility to set the "minOperatingP" value

Parameters:

minOperatingPValue - value to set

minOperatingPIsSet

public boolean minOperatingPIsSet()

Utility to test if the value of "minOperatingP" has been set

Returns:

boolean if true the attribute "minOperatingP" is already set if false isn't yet

getMaxOperatingP

public float getMaxOperatingP()

Utility to return the "maxOperatingP" value

Returns:

the value of the attribute "maxOperatingP"

setMaxOperatingP

public void setMaxOperatingP(float maxOperatingPValue)

Utility to set the "maxOperatingP" value

Parameters:

maxOperatingPValue - value to set

maxOperatingPIsSet

public boolean maxOperatingPIsSet()

Utility to test if the value of "maxOperatingP" has been set

Returns:

boolean if true the attribute "maxOperatingP" is already set if false isn't yet

getContains_SynchronousMachines

public java.util.List<SynchronousMachine> getContains_SynchronousMachines()

Utility to return the "contains_SynchronousMachines" List of "SynchronousMachine" enum

Returns:

the list of the attributes "contains_SynchronousMachines"

addContains_SynchronousMachines

public void addContains_SynchronousMachines(SynchronousMachine contains_SynchronousMachinesValue,
                                            boolean setInverse)
                                     throws LinkageException

Utility to add a value within the "contains_SynchronousMachines" ArrayList of "SynchronousMachine"

Parameters:

contains_SynchronousMachinesValue - value to add within the ArrayList

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

contains_SynchronousMachinesIsSet

public boolean contains_SynchronousMachinesIsSet()

Utility to test if the value of "contains_SynchronousMachines" has been set

Returns:

boolean if true the attribute "contains_SynchronousMachines" is already set if false it isn't yet

create

public static GeneratingUnit create(java.lang.String id)

Factory of the class

Parameters:

id - id of the class GeneratingUnit to create

Returns:

the class created

clearContent

public void clearContent(Subset subset)

Utility to "clear" the content of a class when a subset is invalidated

Overrides:

clearContent in class Equipment

Parameters:

subset - subset to clean

readAttribute

public void readAttribute(java.lang.String class_name,
                          java.lang.String attr_name,
                          java.lang.String value,
                          CIMModel model)
                   throws InterpretationException

Utility to read an attribute This function is called by the CIMModel

Overrides:

readAttribute in class Equipment

Parameters:

class_name - the read name of class

attr_name - the read name of attribute

value - the read value of the attribute

model - the interface to the model this class belongs to

Throws:

InterpretationException

readResource

public void readResource(java.lang.String class_name,
                         java.lang.String resource_name,
                         java.lang.String id,
                         CIMModel model)
                  throws InterpretationException,
                         LinkageException

Utility to read a reference to a resource This function is called by the CIMModel

Overrides:

readResource in class Equipment

Parameters:

class_name - the read name of class

resource_name - the read name of the associated resource

id - the id of the associated resource

model - the model this class belongs to

Throws:

InterpretationException

LinkageException

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  boolean writeID)

Utility to write the content into the CIM XML format

Overrides:

write in class Equipment

Parameters:

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - XMLStreamWriter where are stored the elements to write

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  Subset subset,
                  boolean writeID)

Utility to write the content this class into the CIM/XML format according to a subset

Overrides:

write in class Equipment

Parameters:

subset - the subset defining the context in which to write this class

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - the stream in which are stored the elements to write

resolveLinks

public void resolveLinks(CIMModel model,
                         CIMModel boundaryModel)
                  throws LinkageException

Utility to resolve the links at the end of parsing

Overrides:

resolveLinks in class Equipment

Parameters:

model - the model this class belongs to

boundaryModel - the model that gather data about the boundarySet, used as a resource force links resolving

Throws:

Linkage - Exception

LinkageException

modelConsistency

public ConsistencyCheck modelConsistency(Subset subset)

Utility to check whether this class is consistent according to a subset

Overrides:

modelConsistency in class Equipment

Parameters:

subset - the subset defining the context in which to check whether this class is consistent

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

modelConsistency

public ConsistencyCheck modelConsistency()

Utility to check whether this class is consistent in a "merged" context

Overrides:

modelConsistency in class Equipment

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

copyBase

public void copyBase(GeneratingUnit otherGeneratingUnit)

Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy

Parameters:

otherGeneratingUnit - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

Utility to clear the associations of this class belonging to a specific subset

Overrides:

clearAssociations in class Equipment

Parameters:

subset - the subset from which to clear the associations of this class

clone

public GeneratingUnit clone()

Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances

Overrides:

clone in class Equipment

Returns:

a clone of this instance