MAK RTIspy API Documentation for HLA 1.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
DtSpyXmlBlock Class Reference

Abstract base of all elements / objects in the RTI Spy Web Interface's XML data representation. More...

+ Inheritance diagram for DtSpyXmlBlock:
+ Collaboration diagram for DtSpyXmlBlock:

List of all members.

Public Types

typedef MAKRti::DtString DtXMLParseError
typedef std::pair
< MAKRti::DtEnvValueSP,
MAKRti::DtEnvValueSP > 		DtNodeAndParentPair

Public Member Functions

 DtSpyXmlBlock (const MAKRti::DtString &name, const MAKRti::DtString &type, MAKRti::DtEnvValueSP parent)
 DtSpyXmlBlock (const DtSpyXmlBlock &orig)
 DtSpyXmlBlock (MAKRti::DtEnvValueSP node, MAKRti::DtEnvValueSP parent)
DtSpyXmlBlock & operator= (const DtSpyXmlBlock &orig)
virtual ~DtSpyXmlBlock ()
const MAKRti::DtString & name () const
const MAKRti::DtString & type () const
MAKRti::DtEnvValueSP objectNode () const
void addChild (DtSpyXmlBlockSP child)
void removeChild (DtSpyXmlBlockSP child)
const DtSpyXmlBlockSet & children () const
DtSpyXmlBlockSet & children ()
virtual DtSpyXmlBlockSet childrenByType (const MAKRti::DtString &type) const
virtual DtSpyXmlBlockSP lookupChild (const MAKRti::DtString &name, const MAKRti::DtString &type) const
const DtSpyXmlBlockElementsSet & subElements () const
DtSpyXmlBlockElementsSet & subElements ()
virtual std::ostream & print (std::ostream &ostr) const
template<typename SpyXmlBlockType >
DtBoost::shared_ptr
< SpyXmlBlockType > 		getChildByName (const MAKRti::DtString &name, const MAKRti::DtString &type, const DtSpyXmlBlock &block)

Static Public Member Functions

static DtSpyXmlBlockSP create (MAKRti::DtEnvValueSP node, MAKRti::DtEnvValueSP parent)
static bool isCreatable (MAKRti::DtEnvValueSP node)
template<typename SpyXmlBlockType >
static std::set
< DtBoost::shared_ptr
< SpyXmlBlockType > > 		getChildrenOfType (const MAKRti::DtString &type, const DtSpyXmlBlock &block)

Protected Types

typedef DtPluggableFactory
< MAKRti::DtString,
DtSpyXmlBlock,
DtNodeAndParentPair > 		DtFactory

Protected Member Functions

virtual std::ostream & printAttributes (std::ostream &ostr) const
virtual std::ostream & printElements (std::ostream &ostr) const
void addSubElement (DtSpyXmlBlockElements *element)
void removeSubElement (DtSpyXmlBlockElements *element)
void createChildren ()
MAKRti::DtEnvValueSP findElement (const MAKRti::DtString &type)
MAKRti::DtEnvValueSP findAttribute (const MAKRti::DtString &name)
MAKRti::DtEnvValueSP addElement (const MAKRti::DtString &type, const MAKRti::DtString &initialValue)
MAKRti::DtEnvValueSP addAttribute (const MAKRti::DtString &name, const MAKRti::DtString &initialValue)
MAKRti::DtEnvValueSP removeElement (const MAKRti::DtString &type)
MAKRti::DtEnvValueSP removeAttribute (const MAKRti::DtString &name)
MAKRti::DtEnvValueSP addComment (const MAKRti::DtString &comment)

Protected Attributes

MAKRti::DtString myName
MAKRti::DtString myType
MAKRti::DtEnvValueSP myObjectNode
MAKRti::DtEnvValueSP myParentNode
DtSpyXmlBlockSet myChildren
DtSpyXmlBlockElementsSet myXmlElements
MAKRti::DtEnvironment myEnvironment

Friends

class DtSpyXmlBlockElements

Detailed Description

Abstract base of all elements / objects in the RTI Spy Web Interface's XML data representation.

Simplifies reading/writing of XML for concrete data classes. All elements must have both a name and a type.

Member Typedef Documentation

typedef DtPluggableFactory< MAKRti::DtString, DtSpyXmlBlock, DtNodeAndParentPair > DtSpyXmlBlock::DtFactory [protected]
typedef std::pair< MAKRti::DtEnvValueSP, MAKRti::DtEnvValueSP > DtSpyXmlBlock::DtNodeAndParentPair
typedef MAKRti::DtString DtSpyXmlBlock::DtXMLParseError

Constructor & Destructor Documentation

DtSpyXmlBlock::DtSpyXmlBlock ( const MAKRti::DtString &  name,
const MAKRti::DtString &  type,
MAKRti::DtEnvValueSP  parent 
)
DtSpyXmlBlock::DtSpyXmlBlock ( const DtSpyXmlBlock &  orig)
DtSpyXmlBlock::DtSpyXmlBlock ( MAKRti::DtEnvValueSP  node,
MAKRti::DtEnvValueSP  parent 
)
DtSpyXmlBlock::~DtSpyXmlBlock ( ) [virtual]

References myObjectNode, and myParentNode.

Member Function Documentation

DtEnvValueSP DtSpyXmlBlock::addAttribute ( const MAKRti::DtString &  name,
const MAKRti::DtString &  initialValue 
) [protected]

References findAttribute(), myEnvironment, and myObjectNode.

Referenced by DtSpyXmlBlockElements::DtSpyXmlBlockElements().

void DtSpyXmlBlock::addChild ( DtSpyXmlBlockSP  child) [inline]

References myChildren, myEnvironment, and myObjectNode.

Referenced by DtFomObjectXmlBlock::addAttribute(), DtNetMapXmlBlock::addChildForwarder(), DtNetMapForwarderXmlBlock::addChildForwarder(), DtNetMapForwarderXmlBlock::addChildNode(), DtLrcConsoleLogXmlBlock::addEvent(), DtFederationStateXmlBlock::addFederate(), DtSyncPointXmlBlock::addFederate(), DtFederationListXmlBlock::addFederation(), DtFomStateXmlBlock::addInteraction(), DtFomInteractionXmlBlock::addInteraction(), DtLrcObjInterStatsXmlBlock::addObject(), DtFomStateXmlBlock::addObject(), DtLrcStateDatabaseXmlBlock::addObject(), DtFomObjectXmlBlock::addObject(), DtObjOwnershipInfoXmlBlock::addObject(), DtPubSubXmlBlock::addObject(), DtWwwRequestXmlBlock::addParameter(), DtFomInteractionXmlBlock::addParameter(), DtFederationStateXmlBlock::addSyncPoint(), DtRidParamsXmlBlock::convertRidParams(), createChildren(), DtLrcApiStatsXmlBlock::DtLrcApiStatsXmlBlock(), DtLrcMsgStatsXmlBlock::DtLrcMsgStatsXmlBlock(), DtLrcStateDatabaseXmlBlock::DtLrcStateDatabaseXmlBlock(), DtLrcStateXmlBlock::DtLrcStateXmlBlock(), DtMsgStatsXmlBlock::DtMsgStatsXmlBlock(), DtPubSubXmlBlock::DtPubSubXmlBlock(), DtLrcApiStatsXmlBlock::fedAmbCalled(), DtLrcStateDatabaseXmlBlock::fedAmbCalled(), DtInteractionSendRecvXmlBlock::interactionReceived(), DtInteractionSendRecvXmlBlock::interactionSent(), DtLrcStateDatabaseXmlBlock::messageRead(), DtLrcMsgStatsXmlBlock::messageRead(), DtLrcStateDatabaseXmlBlock::messageSent(), DtLrcMsgStatsXmlBlock::messageSent(), DtLrcObjInterStatsXmlBlock::recordInteraction(), DtLrcStateDatabaseXmlBlock::recordInteraction(), DtLrcApiStatsXmlBlock::rtiAmbCalled(), DtLrcStateDatabaseXmlBlock::rtiAmbCalled(), DtFederateStateContainerXmlBlock::setFederate(), and DtFederateStateXmlBlock::setTimeState().

DtEnvValueSP DtSpyXmlBlock::addComment ( const MAKRti::DtString &  comment) [protected]

References myEnvironment, and myObjectNode.

Referenced by DtFederationListXmlBlock::addFederation().

DtEnvValueSP DtSpyXmlBlock::addElement ( const MAKRti::DtString &  type,
const MAKRti::DtString &  initialValue 
) [protected]

References findElement(), myEnvironment, and myObjectNode.

Referenced by DtSpyXmlBlockElements::DtSpyXmlBlockElements().

void DtSpyXmlBlock::addSubElement ( DtSpyXmlBlockElements *  element) [inline, protected]

References myXmlElements.

Referenced by DtSpyXmlBlockElements::DtSpyXmlBlockElements().

const DtSpyXmlBlockSet & DtSpyXmlBlock::children ( ) const [inline]

References myChildren.

Referenced by getChildByName(), and getChildrenOfType().

DtSpyXmlBlockSet & DtSpyXmlBlock::children ( ) [inline]

References myChildren.

DtSpyXmlBlockSet DtSpyXmlBlock::childrenByType ( const MAKRti::DtString &  type) const [virtual]

References myChildren, and type().

DtSpyXmlBlockSP DtSpyXmlBlock::create ( MAKRti::DtEnvValueSP  node,
MAKRti::DtEnvValueSP  parent 
) [static]

Referenced by DtSpyXmlDocument::DtSpyXmlDocument().

void DtSpyXmlBlock::createChildren ( ) [protected]

References addChild(), DtPluggableFactory< Key, Product, ProductCreatorParameter >::create(), myObjectNode, myXmlElements, and objectNode().

DtEnvValueSP DtSpyXmlBlock::findAttribute ( const MAKRti::DtString &  name) [protected]

References myEnvironment, and myObjectNode.

Referenced by addAttribute(), DtSpyXmlBlockElements::DtSpyXmlBlockElements(), and removeAttribute().

DtEnvValueSP DtSpyXmlBlock::findElement ( const MAKRti::DtString &  type) [protected]

References myEnvironment, and myObjectNode.

Referenced by addElement(), DtSpyXmlBlockElements::DtSpyXmlBlockElements(), and removeElement().

template<typename SpyXmlBlockType >
DtBoost::shared_ptr< SpyXmlBlockType > DtSpyXmlBlock::getChildByName ( const MAKRti::DtString &  name,
const MAKRti::DtString &  type,
const DtSpyXmlBlock &  block 
)

References children(), and type().

template<typename SpyXmlBlockType >
std::set< DtBoost::shared_ptr< SpyXmlBlockType > > DtSpyXmlBlock::getChildrenOfType ( const MAKRti::DtString &  type,
const DtSpyXmlBlock &  block 
) [static]

References children(), and type().

bool DtSpyXmlBlock::isCreatable ( MAKRti::DtEnvValueSP  node) [static]

Referenced by DtSpyXmlDocument::DtSpyXmlDocument().

DtSpyXmlBlockSP DtSpyXmlBlock::lookupChild ( const MAKRti::DtString &  name,
const MAKRti::DtString &  type 
) const [virtual]

References myChildren, and name().

const MAKRti::DtString & DtSpyXmlBlock::name ( ) const [inline]

References myName.

Referenced by DtNetMapForwarderXmlBlock::addSiblingRelationship(), DtRidParamsXmlBlock::getParam(), lookupChild(), DtFomObjectXmlBlock::removeAttribute(), DtFederationListXmlBlock::removeFederation(), DtFomStateXmlBlock::removeInteraction(), DtFomInteractionXmlBlock::removeInteraction(), DtFomStateXmlBlock::removeObject(), DtFomObjectXmlBlock::removeObject(), DtWwwRequestXmlBlock::removeParameter(), DtFomInteractionXmlBlock::removeParameter(), DtFederationStateXmlBlock::removeSyncPoint(), DtLrcStateXmlBlock::setFederateName(), DtFederateStateContainerXmlBlock::setFederationName(), DtFederateStateContainerXmlBlock::setFedFileName(), and DtFederateStateContainerXmlBlock::setRidFileName().

MAKRti::DtEnvValueSP DtSpyXmlBlock::objectNode ( ) const [inline]

References myObjectNode.

Referenced by DtFomObjectXmlBlock::addAttribute(), DtNetMapXmlBlock::addChildForwarder(), DtNetMapForwarderXmlBlock::addChildForwarder(), DtNetMapForwarderXmlBlock::addChildNode(), DtLrcConsoleLogXmlBlock::addEvent(), DtFederationStateXmlBlock::addFederate(), DtSyncPointXmlBlock::addFederate(), DtFederationListXmlBlock::addFederation(), DtFomStateXmlBlock::addInteraction(), DtFomInteractionXmlBlock::addInteraction(), DtLrcObjInterStatsXmlBlock::addObject(), DtFomStateXmlBlock::addObject(), DtLrcStateDatabaseXmlBlock::addObject(), DtFomObjectXmlBlock::addObject(), DtObjOwnershipInfoXmlBlock::addObject(), DtPubSubXmlBlock::addObject(), DtFomInteractionXmlBlock::addParameter(), DtWwwRequestXmlBlock::addParameter(), DtFederationStateXmlBlock::addSyncPoint(), DtRidParamsXmlBlock::convertRidParams(), createChildren(), DtLrcApiStatsXmlBlock::DtLrcApiStatsXmlBlock(), DtLrcMsgStatsXmlBlock::DtLrcMsgStatsXmlBlock(), DtLrcStateDatabaseXmlBlock::DtLrcStateDatabaseXmlBlock(), DtLrcStateXmlBlock::DtLrcStateXmlBlock(), DtMsgStatsXmlBlock::DtMsgStatsXmlBlock(), DtPubSubXmlBlock::DtPubSubXmlBlock(), DtLrcApiStatsXmlBlock::fedAmbCalled(), DtLrcStateDatabaseXmlBlock::fedAmbCalled(), DtInteractionSendRecvXmlBlock::interactionReceived(), DtInteractionSendRecvXmlBlock::interactionSent(), DtLrcStateDatabaseXmlBlock::messageRead(), DtLrcMsgStatsXmlBlock::messageRead(), DtLrcStateDatabaseXmlBlock::messageSent(), DtLrcMsgStatsXmlBlock::messageSent(), DtLrcObjInterStatsXmlBlock::recordInteraction(), DtLrcStateDatabaseXmlBlock::recordInteraction(), DtLrcApiStatsXmlBlock::rtiAmbCalled(), DtLrcStateDatabaseXmlBlock::rtiAmbCalled(), and DtFederateStateXmlBlock::setTimeState().

DtSpyXmlBlock & DtSpyXmlBlock::operator= ( const DtSpyXmlBlock &  orig)

References myChildren, myEnvironment, myName, myObjectNode, myParentNode, myType, and myXmlElements.

ostream & DtSpyXmlBlock::print ( std::ostream &  ostr) const [virtual]

References myName, myType, printAttributes(), and printElements().

Referenced by operator<<().

ostream & DtSpyXmlBlock::printAttributes ( std::ostream &  ostr) const [protected, virtual]

References myXmlElements.

Referenced by print().

ostream & DtSpyXmlBlock::printElements ( std::ostream &  ostr) const [protected, virtual]

References myChildren, and myXmlElements.

Referenced by print().

DtEnvValueSP DtSpyXmlBlock::removeAttribute ( const MAKRti::DtString &  name) [protected]

References findAttribute(), and myEnvironment.

void DtSpyXmlBlock::removeChild ( DtSpyXmlBlockSP  child) [inline]

References myChildren, and myEnvironment.

Referenced by DtFomObjectXmlBlock::removeAttribute(), DtLrcConsoleLogXmlBlock::removeEvent(), DtFederationStateXmlBlock::removeFederate(), DtSyncPointXmlBlock::removeFederate(), DtFederationListXmlBlock::removeFederation(), DtFomStateXmlBlock::removeInteraction(), DtFomInteractionXmlBlock::removeInteraction(), DtFomStateXmlBlock::removeObject(), DtFomObjectXmlBlock::removeObject(), DtObjOwnershipInfoXmlBlock::removeObject(), DtPubSubXmlBlock::removeObject(), DtWwwRequestXmlBlock::removeParameter(), DtFomInteractionXmlBlock::removeParameter(), DtFederationStateXmlBlock::removeSyncPoint(), and DtFederateStateContainerXmlBlock::setFederate().

DtEnvValueSP DtSpyXmlBlock::removeElement ( const MAKRti::DtString &  type) [protected]

References findElement(), and myEnvironment.

void DtSpyXmlBlock::removeSubElement ( DtSpyXmlBlockElements *  element) [inline, protected]

References myEnvironment, myXmlElements, and DtSpyXmlBlockElements::xmlNode().

Referenced by DtSpyXmlBlockElements::~DtSpyXmlBlockElements().

const DtSpyXmlBlockElementsSet & DtSpyXmlBlock::subElements ( ) const [inline]

References myXmlElements.

DtSpyXmlBlockElementsSet & DtSpyXmlBlock::subElements ( ) [inline]

References myXmlElements.

const MAKRti::DtString & DtSpyXmlBlock::type ( ) const [inline]

Reimplemented in DtNetMapNodeXmlBlock, and DtRidParameterXmlBlock.

References myType.

Referenced by childrenByType(), getChildByName(), and getChildrenOfType().

Friends And Related Function Documentation

friend class DtSpyXmlBlockElements [friend]

Member Data Documentation

DtSpyXmlBlockSet DtSpyXmlBlock::myChildren [protected]

Referenced by addChild(), children(), childrenByType(), lookupChild(), operator=(), printElements(), and removeChild().

MAKRti::DtEnvironment DtSpyXmlBlock::myEnvironment [mutable, protected]

Referenced by addAttribute(), addChild(), addComment(), addElement(), findAttribute(), findElement(), operator=(), removeAttribute(), removeChild(), removeElement(), and removeSubElement().

MAKRti::DtString DtSpyXmlBlock::myName [protected]

Referenced by name(), operator=(), and print().

MAKRti::DtEnvValueSP DtSpyXmlBlock::myObjectNode [protected]

Referenced by addAttribute(), addChild(), addComment(), addElement(), createChildren(), findAttribute(), findElement(), objectNode(), operator=(), DtFederateStateXmlBlock::setTimeState(), and ~DtSpyXmlBlock().

MAKRti::DtEnvValueSP DtSpyXmlBlock::myParentNode [protected]

Referenced by operator=(), and ~DtSpyXmlBlock().

MAKRti::DtString DtSpyXmlBlock::myType [protected]

Reimplemented in DtNetMapNodeXmlBlock, and DtRidParameterXmlBlock.

Referenced by operator=(), print(), and type().

DtSpyXmlBlockElementsSet DtSpyXmlBlock::myXmlElements [protected]

Referenced by addSubElement(), createChildren(), operator=(), printAttributes(), printElements(), removeSubElement(), and subElements().

The documentation for this class was generated from the following files:
Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)