cim1.model

Class SynchronousMachine

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Equipment

cim1.model.ConductingEquipment

cim1.model.RegulatingCondEq

cim1.model.SynchronousMachine

public class SynchronousMachine
extends RegulatingCondEq

This file has been automatically generated by CIMGateway Description : This class "SynchronousMachine.java" represents the class SynchronousMachine extends RegulatingCondEq + ratedS 1..1 float + x0 0..1 float + minQ 0..1 float + r2 0..1 float + x2 0..1 float + r 1..1 float + r0 0..1 float + qPercent 1..1 float + MemberOf_GeneratingUnit 1..1 GeneratingUnit + Drives_HydroPump 0..1 HydroPump + operatingMode 1..1 SynchronousMachineOperatingMode + x 1..1 float + type 1..1 SynchronousMachineType + InitialReactiveCapabilityCurve 0..1 ReactiveCapabilityCurve + maxQ 0..1 float

Field Summary

Fields

Modifier and Type	Field and Description
HydroPump	drives_HydroPump Attribute "drives_HydroPump" Comment from profile: The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation.
java.lang.String	idDrives_HydroPump The id of the attribute "drives_HydroPump" This id is mainly used to resolve links after parsing an instance
java.lang.String	idInitialReactiveCapabilityCurve The id of the attribute "initialReactiveCapabilityCurve" This id is mainly used to resolve links after parsing an instance
java.lang.String	idMemberOf_GeneratingUnit The id of the attribute "memberOf_GeneratingUnit" This id is mainly used to resolve links after parsing an instance
ReactiveCapabilityCurve	initialReactiveCapabilityCurve Attribute "initialReactiveCapabilityCurve" Comment from profile: The default ReactiveCapabilityCurve for use by a SynchronousMachine
float	maxQ Attribute "maxQ" Comment from profile: Maximum reactive power limit.
GeneratingUnit	memberOf_GeneratingUnit Attribute "memberOf_GeneratingUnit" Comment from profile: A synchronous machine may operate as a generator and as such becomes a member of a generating unitEach SynchronousMachine is a member of one and only one GeneratingUnit plus each GeneratingUnit should have one and only one SynchronousMachine.
float	minQ Attribute "minQ" Comment from profile: Minimum reactive power limit for the unit.
SynchronousMachineOperatingMode	operatingMode Attribute "operatingMode" Comment from profile: Current mode of operation.
float	qPercent Attribute "qPercent" Comment from profile: Percent of the coordinated reactive control that comes from this machine.
float	r Attribute "r" Comment from profile: Positive sequence resistance of the synchronous machine.
float	r0 Attribute "r0" Comment from profile: Zero sequence resistance of the synchronous machine.This is for Short Circuit only.
float	r2 Attribute "r2" Comment from profile: Negative sequence resistance.This is for Short Circuit only.
float	ratedS Attribute "ratedS" Comment from profile: Nameplate apparent power rating for the unit
SynchronousMachineType	type Attribute "type" Comment from profile: Modes that this synchronous machine can operate in.
float	x Attribute "x" Comment from profile: Positive sequence reactance of the synchronous machine.
float	x0 Attribute "x0" Comment from profile: Zero sequence reactance of the synchronous machine.This is for Short Circuit only.
float	x2 Attribute "x2" Comment from profile: Negative sequence reactance.This is for Short Circuit only.

Fields inherited from class cim1.model.RegulatingCondEq

idRegulatingControl, regulatingControl

Fields inherited from class cim1.model.ConductingEquipment

baseVoltage, idBaseVoltage, terminals

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	SynchronousMachine() Constructor of the class SynchronousMachine

Method Summary

Modifier and Type	Method and Description
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
SynchronousMachine	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(SynchronousMachine otherSynchronousMachine) 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 SynchronousMachine	create(java.lang.String id) Factory of the class
boolean	drives_HydroPumpIsSet() Utility to test if the value of "drives_HydroPump" has been set
HydroPump	getDrives_HydroPump() Utility to return the "drives_HydroPump"
ReactiveCapabilityCurve	getInitialReactiveCapabilityCurve() Utility to return the "initialReactiveCapabilityCurve"
float	getMaxQ() Utility to return the "maxQ" value
GeneratingUnit	getMemberOf_GeneratingUnit() Utility to return the "memberOf_GeneratingUnit"
float	getMinQ() Utility to return the "minQ" value
SynchronousMachineOperatingMode	getOperatingMode() Utility to return the "operatingMode" enum
float	getQPercent() Utility to return the "qPercent" value
float	getR() Utility to return the "r" value
float	getR0() Utility to return the "r0" value
float	getR2() Utility to return the "r2" value
float	getRatedS() Utility to return the "ratedS" value
SynchronousMachineType	getType() Utility to return the "type" enum
float	getX() Utility to return the "x" value
float	getX0() Utility to return the "x0" value
float	getX2() Utility to return the "x2" value
boolean	initialReactiveCapabilityCurveIsSet() Utility to test if the value of "initialReactiveCapabilityCurve" has been set
boolean	maxQIsSet() Utility to test if the value of "maxQ" has been set
boolean	memberOf_GeneratingUnitIsSet() Utility to test if the value of "memberOf_GeneratingUnit" has been set
boolean	minQIsSet() Utility to test if the value of "minQ" 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	operatingModeIsSet() Utility to test if the value of "operatingMode" has been set
boolean	qPercentIsSet() Utility to test if the value of "qPercent" has been set
boolean	r0IsSet() Utility to test if the value of "r0" has been set
boolean	r2IsSet() Utility to test if the value of "r2" has been set
boolean	ratedSIsSet() Utility to test if the value of "ratedS" 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
boolean	rIsSet() Utility to test if the value of "r" has been set
void	setDrives_HydroPump(HydroPump drives_HydroPumpValue, boolean setInverse) Utility to set the "drives_HydroPumpValue"
void	setInitialReactiveCapabilityCurve(ReactiveCapabilityCurve initialReactiveCapabilityCurveValue, boolean setInverse) Utility to set the "initialReactiveCapabilityCurveValue"
void	setMaxQ(float maxQValue) Utility to set the "maxQ" value
void	setMemberOf_GeneratingUnit(GeneratingUnit memberOf_GeneratingUnitValue, boolean setInverse) Utility to set the "memberOf_GeneratingUnitValue"
void	setMinQ(float minQValue) Utility to set the "minQ" value
void	setOperatingMode(SynchronousMachineOperatingMode operatingModeValue) Utility to set the "operatingMode" enum
void	setQPercent(float qPercentValue) Utility to set the "qPercent" value
void	setR(float rValue) Utility to set the "r" value
void	setR0(float r0Value) Utility to set the "r0" value
void	setR2(float r2Value) Utility to set the "r2" value
void	setRatedS(float ratedSValue) Utility to set the "ratedS" value
void	setType(SynchronousMachineType typeValue) Utility to set the "type" enum
void	setX(float xValue) Utility to set the "x" value
void	setX0(float x0Value) Utility to set the "x0" value
void	setX2(float x2Value) Utility to set the "x2" value
boolean	typeIsSet() Utility to test if the value of "type" 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
boolean	x0IsSet() Utility to test if the value of "x0" has been set
boolean	x2IsSet() Utility to test if the value of "x2" has been set
boolean	xIsSet() Utility to test if the value of "x" has been set

Methods inherited from class cim1.model.RegulatingCondEq

copyBase, getRegulatingControl, regulatingControlIsSet, setRegulatingControl

Methods inherited from class cim1.model.ConductingEquipment

addTerminals, baseVoltageIsSet, copyBase, getBaseVoltage, getTerminals, setBaseVoltage, terminalsIsSet

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

ratedS

public float ratedS

Attribute "ratedS" Comment from profile: Nameplate apparent power rating for the unit

x0

public float x0

Attribute "x0" Comment from profile: Zero sequence reactance of the synchronous machine.This is for Short Circuit only.

minQ

public float minQ

Attribute "minQ" Comment from profile: Minimum reactive power limit for the unit.

r2

public float r2

Attribute "r2" Comment from profile: Negative sequence resistance.This is for Short Circuit only.

x2

public float x2

Attribute "x2" Comment from profile: Negative sequence reactance.This is for Short Circuit only.

r

public float r

Attribute "r" Comment from profile: Positive sequence resistance of the synchronous machine.

r0

public float r0

Attribute "r0" Comment from profile: Zero sequence resistance of the synchronous machine.This is for Short Circuit only.

qPercent

public float qPercent

Attribute "qPercent" Comment from profile: Percent of the coordinated reactive control that comes from this machine.

memberOf_GeneratingUnit

public GeneratingUnit memberOf_GeneratingUnit

Attribute "memberOf_GeneratingUnit" Comment from profile: A synchronous machine may operate as a generator and as such becomes a member of a generating unitEach SynchronousMachine is a member of one and only one GeneratingUnit plus each GeneratingUnit should have one and only one SynchronousMachine. This is required to properly proportion generation limits specified on GeneratingUnit to the appropriate injection points specified by SynchronousMachine and its Terminal connection.

idMemberOf_GeneratingUnit

public java.lang.String idMemberOf_GeneratingUnit

The id of the attribute "memberOf_GeneratingUnit" This id is mainly used to resolve links after parsing an instance

drives_HydroPump

public HydroPump drives_HydroPump

Attribute "drives_HydroPump" Comment from profile: The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating.

idDrives_HydroPump

public java.lang.String idDrives_HydroPump

The id of the attribute "drives_HydroPump" This id is mainly used to resolve links after parsing an instance

operatingMode

public SynchronousMachineOperatingMode operatingMode

Attribute "operatingMode" Comment from profile: Current mode of operation.

x

public float x

Attribute "x" Comment from profile: Positive sequence reactance of the synchronous machine.

type

public SynchronousMachineType type

Attribute "type" Comment from profile: Modes that this synchronous machine can operate in.

initialReactiveCapabilityCurve

public ReactiveCapabilityCurve initialReactiveCapabilityCurve

Attribute "initialReactiveCapabilityCurve" Comment from profile: The default ReactiveCapabilityCurve for use by a SynchronousMachine

idInitialReactiveCapabilityCurve

public java.lang.String idInitialReactiveCapabilityCurve

The id of the attribute "initialReactiveCapabilityCurve" This id is mainly used to resolve links after parsing an instance

maxQ

public float maxQ

Attribute "maxQ" Comment from profile: Maximum reactive power limit. This is the maximum (nameplate) limit for the unit.

Constructor Detail

SynchronousMachine

protected SynchronousMachine()

Constructor of the class SynchronousMachine

Method Detail

getRatedS

public float getRatedS()

Utility to return the "ratedS" value

Returns:

the value of the attribute "ratedS"

setRatedS

public void setRatedS(float ratedSValue)

Utility to set the "ratedS" value

Parameters:

ratedSValue - value to set

ratedSIsSet

public boolean ratedSIsSet()

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

Returns:

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

getX0

public float getX0()

Utility to return the "x0" value

Returns:

the value of the attribute "x0"

setX0

public void setX0(float x0Value)

Utility to set the "x0" value

Parameters:

x0Value - value to set

x0IsSet

public boolean x0IsSet()

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

Returns:

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

getMinQ

public float getMinQ()

Utility to return the "minQ" value

Returns:

the value of the attribute "minQ"

setMinQ

public void setMinQ(float minQValue)

Utility to set the "minQ" value

Parameters:

minQValue - value to set

minQIsSet

public boolean minQIsSet()

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

Returns:

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

getR2

public float getR2()

Utility to return the "r2" value

Returns:

the value of the attribute "r2"

setR2

public void setR2(float r2Value)

Utility to set the "r2" value

Parameters:

r2Value - value to set

r2IsSet

public boolean r2IsSet()

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

Returns:

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

getX2

public float getX2()

Utility to return the "x2" value

Returns:

the value of the attribute "x2"

setX2

public void setX2(float x2Value)

Utility to set the "x2" value

Parameters:

x2Value - value to set

x2IsSet

public boolean x2IsSet()

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

Returns:

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

getR

public float getR()

Utility to return the "r" value

Returns:

the value of the attribute "r"

setR

public void setR(float rValue)

Utility to set the "r" value

Parameters:

rValue - value to set

rIsSet

public boolean rIsSet()

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

Returns:

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

getR0

public float getR0()

Utility to return the "r0" value

Returns:

the value of the attribute "r0"

setR0

public void setR0(float r0Value)

Utility to set the "r0" value

Parameters:

r0Value - value to set

r0IsSet

public boolean r0IsSet()

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

Returns:

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

getQPercent

public float getQPercent()

Utility to return the "qPercent" value

Returns:

the value of the attribute "qPercent"

setQPercent

public void setQPercent(float qPercentValue)

Utility to set the "qPercent" value

Parameters:

qPercentValue - value to set

qPercentIsSet

public boolean qPercentIsSet()

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

Returns:

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

getMemberOf_GeneratingUnit

public GeneratingUnit getMemberOf_GeneratingUnit()

Utility to return the "memberOf_GeneratingUnit"

Returns:

the value of the attribute "memberOf_GeneratingUnit"

memberOf_GeneratingUnitIsSet

public boolean memberOf_GeneratingUnitIsSet()

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

Returns:

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

setMemberOf_GeneratingUnit

public void setMemberOf_GeneratingUnit(GeneratingUnit memberOf_GeneratingUnitValue,
                                       boolean setInverse)
                                throws LinkageException

Utility to set the "memberOf_GeneratingUnitValue"

Parameters:

memberOf_GeneratingUnitValue - instance to set

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

Throws:

LinkageException

getDrives_HydroPump

public HydroPump getDrives_HydroPump()

Utility to return the "drives_HydroPump"

Returns:

the value of the attribute "drives_HydroPump"

drives_HydroPumpIsSet

public boolean drives_HydroPumpIsSet()

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

Returns:

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

setDrives_HydroPump

public void setDrives_HydroPump(HydroPump drives_HydroPumpValue,
                                boolean setInverse)
                         throws LinkageException

Utility to set the "drives_HydroPumpValue"

Parameters:

drives_HydroPumpValue - instance to set

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

Throws:

LinkageException

getOperatingMode

public SynchronousMachineOperatingMode getOperatingMode()

Utility to return the "operatingMode" enum

Returns:

the value of the attribute "operatingMode"

setOperatingMode

public void setOperatingMode(SynchronousMachineOperatingMode operatingModeValue)

Utility to set the "operatingMode" enum

Parameters:

operatingModeValue - operand to set

operatingModeIsSet

public boolean operatingModeIsSet()

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

Returns:

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

getX

public float getX()

Utility to return the "x" value

Returns:

the value of the attribute "x"

setX

public void setX(float xValue)

Utility to set the "x" value

Parameters:

xValue - value to set

xIsSet

public boolean xIsSet()

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

Returns:

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

getType

public SynchronousMachineType getType()

Utility to return the "type" enum

Returns:

the value of the attribute "type"

setType

public void setType(SynchronousMachineType typeValue)

Utility to set the "type" enum

Parameters:

typeValue - operand to set

typeIsSet

public boolean typeIsSet()

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

Returns:

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

getInitialReactiveCapabilityCurve

public ReactiveCapabilityCurve getInitialReactiveCapabilityCurve()

Utility to return the "initialReactiveCapabilityCurve"

Returns:

the value of the attribute "initialReactiveCapabilityCurve"

initialReactiveCapabilityCurveIsSet

public boolean initialReactiveCapabilityCurveIsSet()

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

Returns:

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

setInitialReactiveCapabilityCurve

public void setInitialReactiveCapabilityCurve(ReactiveCapabilityCurve initialReactiveCapabilityCurveValue,
                                              boolean setInverse)
                                       throws LinkageException

Utility to set the "initialReactiveCapabilityCurveValue"

Parameters:

initialReactiveCapabilityCurveValue - instance to set

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

Throws:

LinkageException

getMaxQ

public float getMaxQ()

Utility to return the "maxQ" value

Returns:

the value of the attribute "maxQ"

setMaxQ

public void setMaxQ(float maxQValue)

Utility to set the "maxQ" value

Parameters:

maxQValue - value to set

maxQIsSet

public boolean maxQIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class SynchronousMachine 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 RegulatingCondEq

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 RegulatingCondEq

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 RegulatingCondEq

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 RegulatingCondEq

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 RegulatingCondEq

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 RegulatingCondEq

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 RegulatingCondEq

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 RegulatingCondEq

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(SynchronousMachine otherSynchronousMachine)

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:

otherSynchronousMachine - 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 RegulatingCondEq

Parameters:

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

clone

public SynchronousMachine 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 RegulatingCondEq

Returns:

a clone of this instance