FrameIT
CylinderVolumeFact Class Reference

The volume of a cylinder defined by a base area CircleFact, a top area CircleFact and the volume as float More...

Inheritance diagram for CylinderVolumeFact:
FactWrappedCRTP< CylinderVolumeFact >

Public Member Functions

 CylinderVolumeFact ()
 
 CylinderVolumeFact (string cid1, string cid2, float vol, string eqProof, OMA proof)
 Standard Constructor: Initiates members and creates MMT Fact Server-Side More...
 
 CylinderVolumeFact (string Cid1, string Cid2, float volume, string eqProof, OMA proof, SOMDoc _ServerDefinition)
 Bypasses initialization of new MMT Fact by using existend URI, which is not checked for existence. More...
 
override MMTFact MakeMMTDeclaration ()
 
override SOMDoc Defines ()
 
- Public Member Functions inherited from FactWrappedCRTP< CylinderVolumeFact >
override bool Equivalent (Fact f2)
 Compares this against f2 . More...
 
override bool Equivalent (Fact f1, Fact f2)
 Compares f1 against f2 . More...
 

Static Public Member Functions

static new IEnumerator parseFact (List< Fact > ret, MMTFact fact)
 

Public Attributes

string Cid1
 a CircleFact describing the base area More...
 
string Cid2
 a CircleFact describing the top area More...
 
float volume
 the volume of the cylinder as a float More...
 
string equalCirclesProof
 a proof that both circles have the same size More...
 
OMA proof
 OMA proof that the two circles are parallel More...
 

Protected Member Functions

override void RecalculateTransform ()
 
override string generateLabel (FactRecorder name_space)
 auto-generates GetLabel using generation variable(s) e.g. LabelId; if custom GetLabel is set, tries to restore original generated GetLabel without resetting _CustomLabel. If original GetLabel is already taken, a new one will be generated. More...
 
override string[] GetDependentFactIds ()
 
override bool EquivalentWrapped (CylinderVolumeFact f1, CylinderVolumeFact f2)
 Compares f1 against f2 . More...
 
override Fact _ReInitializeMe (Dictionary< string, string > old_to_new)
 
- Protected Member Functions inherited from FactWrappedCRTP< CylinderVolumeFact >
 FactWrappedCRTP ()
 
abstract bool EquivalentWrapped (T f1, T f2)
 CRTP step of Equivalent(Fact) and Equivalent(Fact, Fact) More...
 
bool DependentFactsEquivalent (T f1, T f2)
 

Properties

CircleFact Circle1 [get]
 
CircleFact Circle2 [get]
 
override bool HasDependentFacts [get]
 

Detailed Description

The volume of a cylinder defined by a base area CircleFact, a top area CircleFact and the volume as float

Constructor & Destructor Documentation

◆ CylinderVolumeFact() [1/3]

CylinderVolumeFact.CylinderVolumeFact ( )

Only being used by JsonReader to initiate empty Facts.

See also
SOMDocManager

◆ CylinderVolumeFact() [2/3]

CylinderVolumeFact.CylinderVolumeFact ( string  cid1,
string  cid2,
float  vol,
string  eqProof,
OMA  proof 
)

Standard Constructor: Initiates members and creates MMT Fact Server-Side

Parameters
cid1sets Cid1
cid2sets Cid2
volsets volume
proofsets proof

◆ CylinderVolumeFact() [3/3]

CylinderVolumeFact.CylinderVolumeFact ( string  Cid1,
string  Cid2,
float  volume,
string  eqProof,
OMA  proof,
SOMDoc  _ServerDefinition 
)

Bypasses initialization of new MMT Fact by using existend URI, which is not checked for existence.

Parameters
Cid1sets Cid1
Cid2sets Cid2
volumesets volume
proofsets proof
backendURIMMT URI

Member Function Documentation

◆ _ReInitializeMe()

override Fact CylinderVolumeFact._ReInitializeMe ( Dictionary< string, string >  old_to_new)
protected

◆ Defines()

override SOMDoc CylinderVolumeFact.Defines ( )

◆ EquivalentWrapped()

override bool CylinderVolumeFact.EquivalentWrapped ( CylinderVolumeFact  f1,
CylinderVolumeFact  f2 
)
protected

Compares f1 against f2 .

Parameters
f1Fact to compare to
f2Fact to compare to
Returns
true if f2 is semantical very similar to f1

◆ generateLabel()

override string CylinderVolumeFact.generateLabel ( FactRecorder  name_space)
protected

auto-generates GetLabel using generation variable(s) e.g. LabelId; if custom GetLabel is set, tries to restore original generated GetLabel without resetting _CustomLabel. If original GetLabel is already taken, a new one will be generated.

Returns
auto-generated GetLabel

◆ GetDependentFactIds()

override string[] CylinderVolumeFact.GetDependentFactIds ( )
protected

◆ MakeMMTDeclaration()

override MMTFact CylinderVolumeFact.MakeMMTDeclaration ( )

◆ parseFact()

static new IEnumerator CylinderVolumeFact.parseFact ( List< Fact ret,
MMTFact  fact 
)
static

◆ RecalculateTransform()

override void CylinderVolumeFact.RecalculateTransform ( )
protected

Member Data Documentation

◆ Cid1

string CylinderVolumeFact.Cid1

a CircleFact describing the base area

◆ Cid2

string CylinderVolumeFact.Cid2

a CircleFact describing the top area

◆ equalCirclesProof

string CylinderVolumeFact.equalCirclesProof

a proof that both circles have the same size

◆ proof

OMA CylinderVolumeFact.proof

OMA proof that the two circles are parallel

◆ volume

float CylinderVolumeFact.volume

the volume of the cylinder as a float

Property Documentation

◆ Circle1

CircleFact CylinderVolumeFact.Circle1
get

◆ Circle2

CircleFact CylinderVolumeFact.Circle2
get

◆ HasDependentFacts

override bool CylinderVolumeFact.HasDependentFacts
get


The documentation for this class was generated from the following file: