cim1.model

Class Conductor

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.Equipment

cim1.model.ConductingEquipment

cim1.model.Conductor

Direct Known Subclasses:

ACLineSegment

public class Conductor
extends ConductingEquipment

This file has been automatically generated by CIMGateway Description : This class "Conductor.java" represents the class Conductor extends ConductingEquipment + g0ch 0..1 float + b0ch 0..1 float + length 0..1 float + gch 0..1 float + x 1..1 float + bch 1..1 float + x0 0..1 float + r 1..1 float + r0 0..1 float

Field Summary

Fields

Modifier and Type	Field and Description
float	b0ch Attribute "b0ch" Comment from profile: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.This is for Short Circuit only.
float	bch Attribute "bch" Comment from profile: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.
float	g0ch Attribute "g0ch" Comment from profile: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.This is for Short Circuit only.
float	gch Attribute "gch" Comment from profile: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.This is for Short Circuit only.
float	length Attribute "length" Comment from profile: Segment length for calculating line section capabilitiesRequired only for ACLineSegement objects involved in MutualCoupling.
float	r Attribute "r" Comment from profile: Positive sequence series resistance of the entire line section.
float	r0 Attribute "r0" Comment from profile: Zero sequence series resistance of the entire line section.This is for Short Circuit only.
float	x Attribute "x" Comment from profile: Positive sequence series reactance of the entire line section.
float	x0 Attribute "x0" Comment from profile: Zero sequence series reactance of the entire line section.This is for Short Circuit only.

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

Method Summary

Modifier and Type	Method and Description
boolean	b0chIsSet() Utility to test if the value of "b0ch" has been set
boolean	bchIsSet() Utility to test if the value of "bch" 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
Conductor	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(Conductor otherConductor) 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 Conductor	create(java.lang.String id) Factory of the class
boolean	g0chIsSet() Utility to test if the value of "g0ch" has been set
boolean	gchIsSet() Utility to test if the value of "gch" has been set
float	getB0ch() Utility to return the "b0ch" value
float	getBch() Utility to return the "bch" value
float	getG0ch() Utility to return the "g0ch" value
float	getGch() Utility to return the "gch" value
float	getLength() Utility to return the "length" value
float	getR() Utility to return the "r" value
float	getR0() Utility to return the "r0" value
float	getX() Utility to return the "x" value
float	getX0() Utility to return the "x0" value
boolean	lengthIsSet() Utility to test if the value of "length" 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	r0IsSet() Utility to test if the value of "r0" 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	setB0ch(float b0chValue) Utility to set the "b0ch" value
void	setBch(float bchValue) Utility to set the "bch" value
void	setG0ch(float g0chValue) Utility to set the "g0ch" value
void	setGch(float gchValue) Utility to set the "gch" value
void	setLength(float lengthValue) Utility to set the "length" value
void	setR(float rValue) Utility to set the "r" value
void	setR0(float r0Value) Utility to set the "r0" value
void	setX(float xValue) Utility to set the "x" value
void	setX0(float x0Value) Utility to set the "x0" value
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	xIsSet() Utility to test if the value of "x" has been set

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

g0ch

public float g0ch

Attribute "g0ch" Comment from profile: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.This is for Short Circuit only.

b0ch

public float b0ch

Attribute "b0ch" Comment from profile: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.This is for Short Circuit only.

length

public float length

Attribute "length" Comment from profile: Segment length for calculating line section capabilitiesRequired only for ACLineSegement objects involved in MutualCoupling.

gch

public float gch

Attribute "gch" Comment from profile: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.This is for Short Circuit only.

x

public float x

Attribute "x" Comment from profile: Positive sequence series reactance of the entire line section.

bch

public float bch

Attribute "bch" Comment from profile: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.

x0

public float x0

Attribute "x0" Comment from profile: Zero sequence series reactance of the entire line section.This is for Short Circuit only.

r

public float r

Attribute "r" Comment from profile: Positive sequence series resistance of the entire line section.

r0

public float r0

Attribute "r0" Comment from profile: Zero sequence series resistance of the entire line section.This is for Short Circuit only.

Constructor Detail

Conductor

protected Conductor()

Constructor of the class Conductor

Method Detail

getG0ch

public float getG0ch()

Utility to return the "g0ch" value

Returns:

the value of the attribute "g0ch"

setG0ch

public void setG0ch(float g0chValue)

Utility to set the "g0ch" value

Parameters:

g0chValue - value to set

g0chIsSet

public boolean g0chIsSet()

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

Returns:

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

getB0ch

public float getB0ch()

Utility to return the "b0ch" value

Returns:

the value of the attribute "b0ch"

setB0ch

public void setB0ch(float b0chValue)

Utility to set the "b0ch" value

Parameters:

b0chValue - value to set

b0chIsSet

public boolean b0chIsSet()

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

Returns:

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

getLength

public float getLength()

Utility to return the "length" value

Returns:

the value of the attribute "length"

setLength

public void setLength(float lengthValue)

Utility to set the "length" value

Parameters:

lengthValue - value to set

lengthIsSet

public boolean lengthIsSet()

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

Returns:

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

getGch

public float getGch()

Utility to return the "gch" value

Returns:

the value of the attribute "gch"

setGch

public void setGch(float gchValue)

Utility to set the "gch" value

Parameters:

gchValue - value to set

gchIsSet

public boolean gchIsSet()

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

Returns:

boolean if true the attribute "gch" is already set if false 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

getBch

public float getBch()

Utility to return the "bch" value

Returns:

the value of the attribute "bch"

setBch

public void setBch(float bchValue)

Utility to set the "bch" value

Parameters:

bchValue - value to set

bchIsSet

public boolean bchIsSet()

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

Returns:

boolean if true the attribute "bch" 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

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

create

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

Factory of the class

Parameters:

id - id of the class Conductor 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 ConductingEquipment

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 ConductingEquipment

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 ConductingEquipment

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 ConductingEquipment

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 ConductingEquipment

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 ConductingEquipment

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 ConductingEquipment

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 ConductingEquipment

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(Conductor otherConductor)

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:

otherConductor - 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 ConductingEquipment

Parameters:

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

clone

public Conductor 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 ConductingEquipment

Returns:

a clone of this instance