cim1.model

Class ShuntCompensator

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Equipment

cim1.model.ConductingEquipment

cim1.model.RegulatingCondEq

cim1.model.ShuntCompensator

public class ShuntCompensator
extends RegulatingCondEq

This file has been automatically generated by CIMGateway Description : This class "ShuntCompensator.java" represents the class ShuntCompensator extends RegulatingCondEq + SvShuntCompensatorSections 0..1 SvShuntCompensatorSections + gPerSection 1..1 float + bPerSection 1..1 float + g0PerSection 0..1 float + b0PerSection 0..1 float + maximumSections 1..1 int

Field Summary

Fields

Modifier and Type	Field and Description
float	b0PerSection Attribute "b0PerSection" Comment from profile: Zero sequence shunt (charging) susceptance per sectionThis is for Short Circuit only.
float	bPerSection Attribute "bPerSection" Comment from profile: Positive sequence shunt (charging) susceptance per section
float	g0PerSection Attribute "g0PerSection" Comment from profile: Zero sequence shunt (charging) conductance per sectionThis is for Short Circuit only.
float	gPerSection Attribute "gPerSection" Comment from profile: Positive sequence shunt (charging) conductance per section
java.lang.String	idSvShuntCompensatorSections The id of the attribute "svShuntCompensatorSections" This id is mainly used to resolve links after parsing an instance
int	maximumSections Attribute "maximumSections" Comment from profile: For a capacitor bank, the maximum number of sections that may be switched in.
SvShuntCompensatorSections	svShuntCompensatorSections Attribute "svShuntCompensatorSections" Comment from profile: The state for the number of shunt compensator sections in service.

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

Method Summary

Modifier and Type	Method and Description
boolean	b0PerSectionIsSet() Utility to test if the value of "b0PerSection" has been set
boolean	bPerSectionIsSet() Utility to test if the value of "bPerSection" has been set
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
ShuntCompensator	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(ShuntCompensator otherShuntCompensator) 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 ShuntCompensator	create(java.lang.String id) Factory of the class
boolean	g0PerSectionIsSet() Utility to test if the value of "g0PerSection" has been set
float	getB0PerSection() Utility to return the "b0PerSection" value
float	getBPerSection() Utility to return the "bPerSection" value
float	getG0PerSection() Utility to return the "g0PerSection" value
float	getGPerSection() Utility to return the "gPerSection" value
int	getMaximumSections() Utility to return the "maximumSections" value
SvShuntCompensatorSections	getSvShuntCompensatorSections() Utility to return the "svShuntCompensatorSections"
boolean	gPerSectionIsSet() Utility to test if the value of "gPerSection" has been set
boolean	maximumSectionsIsSet() Utility to test if the value of "maximumSections" 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
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	setB0PerSection(float b0PerSectionValue) Utility to set the "b0PerSection" value
void	setBPerSection(float bPerSectionValue) Utility to set the "bPerSection" value
void	setG0PerSection(float g0PerSectionValue) Utility to set the "g0PerSection" value
void	setGPerSection(float gPerSectionValue) Utility to set the "gPerSection" value
void	setMaximumSections(int maximumSectionsValue) Utility to set the "maximumSections" value
void	setSvShuntCompensatorSections(SvShuntCompensatorSections svShuntCompensatorSectionsValue, boolean setInverse) Utility to set the "svShuntCompensatorSectionsValue"
boolean	svShuntCompensatorSectionsIsSet() Utility to test if the value of "svShuntCompensatorSections" 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.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

svShuntCompensatorSections

public SvShuntCompensatorSections svShuntCompensatorSections

Attribute "svShuntCompensatorSections" Comment from profile: The state for the number of shunt compensator sections in service.

idSvShuntCompensatorSections

public java.lang.String idSvShuntCompensatorSections

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

gPerSection

public float gPerSection

Attribute "gPerSection" Comment from profile: Positive sequence shunt (charging) conductance per section

bPerSection

public float bPerSection

Attribute "bPerSection" Comment from profile: Positive sequence shunt (charging) susceptance per section

g0PerSection

public float g0PerSection

Attribute "g0PerSection" Comment from profile: Zero sequence shunt (charging) conductance per sectionThis is for Short Circuit only.

b0PerSection

public float b0PerSection

Attribute "b0PerSection" Comment from profile: Zero sequence shunt (charging) susceptance per sectionThis is for Short Circuit only.

maximumSections

public int maximumSections

Attribute "maximumSections" Comment from profile: For a capacitor bank, the maximum number of sections that may be switched in.

Constructor Detail

ShuntCompensator

protected ShuntCompensator()

Constructor of the class ShuntCompensator

Method Detail

getSvShuntCompensatorSections

public SvShuntCompensatorSections getSvShuntCompensatorSections()

Utility to return the "svShuntCompensatorSections"

Returns:

the value of the attribute "svShuntCompensatorSections"

svShuntCompensatorSectionsIsSet

public boolean svShuntCompensatorSectionsIsSet()

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

Returns:

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

setSvShuntCompensatorSections

public void setSvShuntCompensatorSections(SvShuntCompensatorSections svShuntCompensatorSectionsValue,
                                          boolean setInverse)
                                   throws LinkageException

Utility to set the "svShuntCompensatorSectionsValue"

Parameters:

svShuntCompensatorSectionsValue - instance to set

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

Throws:

LinkageException

getGPerSection

public float getGPerSection()

Utility to return the "gPerSection" value

Returns:

the value of the attribute "gPerSection"

setGPerSection

public void setGPerSection(float gPerSectionValue)

Utility to set the "gPerSection" value

Parameters:

gPerSectionValue - value to set

gPerSectionIsSet

public boolean gPerSectionIsSet()

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

Returns:

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

getBPerSection

public float getBPerSection()

Utility to return the "bPerSection" value

Returns:

the value of the attribute "bPerSection"

setBPerSection

public void setBPerSection(float bPerSectionValue)

Utility to set the "bPerSection" value

Parameters:

bPerSectionValue - value to set

bPerSectionIsSet

public boolean bPerSectionIsSet()

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

Returns:

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

getG0PerSection

public float getG0PerSection()

Utility to return the "g0PerSection" value

Returns:

the value of the attribute "g0PerSection"

setG0PerSection

public void setG0PerSection(float g0PerSectionValue)

Utility to set the "g0PerSection" value

Parameters:

g0PerSectionValue - value to set

g0PerSectionIsSet

public boolean g0PerSectionIsSet()

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

Returns:

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

getB0PerSection

public float getB0PerSection()

Utility to return the "b0PerSection" value

Returns:

the value of the attribute "b0PerSection"

setB0PerSection

public void setB0PerSection(float b0PerSectionValue)

Utility to set the "b0PerSection" value

Parameters:

b0PerSectionValue - value to set

b0PerSectionIsSet

public boolean b0PerSectionIsSet()

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

Returns:

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

getMaximumSections

public int getMaximumSections()

Utility to return the "maximumSections" value

Returns:

the value of the attribute "maximumSections"

setMaximumSections

public void setMaximumSections(int maximumSectionsValue)

Utility to set the "maximumSections" value

Parameters:

maximumSectionsValue - value to set

maximumSectionsIsSet

public boolean maximumSectionsIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class ShuntCompensator 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(ShuntCompensator otherShuntCompensator)

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:

otherShuntCompensator - 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 ShuntCompensator 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