Choreonoid  1.8
Public Types | Public Member Functions | Protected Member Functions | List of all members
cnoid::DigitalIoConnection Class Reference

#include <IoConnectionMap.h>

Inheritance diagram for cnoid::DigitalIoConnection:
cnoid::ClonableReferenced cnoid::Referenced

Public Types

enum  IoType { In = 0, Out = 1 }
 

Public Member Functions

 DigitalIoConnection ()
 
 DigitalIoConnection (DigitalIoDevice *outDevice, int outIndex, DigitalIoDevice *inDevice, int inIndex)
 
DigitalIoConnectionclone () const
 
DigitalIoConnectionclone (CloneMap &cloneMap) const
 
DigitalIoDevicedevice (int which) const
 
int signalIndex (int which) const
 
const std::string & bodyName (int which) const
 
const std::string & deviceName (int which) const
 
bool hasDeviceInstances () const
 
void setDevice (int which, DigitalIoDevice *device)
 
void setNames (int which, const std::string &bodyName, const std::string &deviceName)
 
void setSignalIndex (int which, int index)
 
DigitalIoDeviceoutDevice ()
 
int outSignalIndex () const
 
const std::string & outBodyName (int which) const
 
const std::string & outDeviceName (int which) const
 
DigitalIoDeviceinDevice ()
 
int inSignalIndex () const
 
const std::string & inBodyName (int which) const
 
const std::string & inDeviceName (int which) const
 
void setInDevice (DigitalIoDevice *device)
 
void setInSignalIndex (int index)
 
void setOutDevice (DigitalIoDevice *device)
 
void setOutSignalIndex (int index)
 
const std::string & note ()
 
void setNote (const std::string &note)
 
bool establishConnection ()
 
void releaseConnection ()
 
bool read (const Mapping &archive)
 
bool write (Mapping &archive) const
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 

Protected Member Functions

 DigitalIoConnection (const DigitalIoConnection &org, CloneMap *cloneMap)
 
virtual ReferenceddoClone (CloneMap *cloneMap) const override
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &)
 
int refCount () const
 

Member Enumeration Documentation

◆ IoType

Enumerator
In 
Out 

Constructor & Destructor Documentation

◆ DigitalIoConnection() [1/3]

DigitalIoConnection::DigitalIoConnection ( )

◆ DigitalIoConnection() [2/3]

DigitalIoConnection::DigitalIoConnection ( DigitalIoDevice outDevice,
int  outIndex,
DigitalIoDevice inDevice,
int  inIndex 
)

◆ DigitalIoConnection() [3/3]

DigitalIoConnection::DigitalIoConnection ( const DigitalIoConnection org,
CloneMap cloneMap 
)
protected

Member Function Documentation

◆ bodyName()

const std::string & DigitalIoConnection::bodyName ( int  which) const

◆ clone() [1/2]

DigitalIoConnection* cnoid::DigitalIoConnection::clone ( ) const
inline

◆ clone() [2/2]

DigitalIoConnection* cnoid::DigitalIoConnection::clone ( CloneMap cloneMap) const
inline

◆ device()

DigitalIoDevice* cnoid::DigitalIoConnection::device ( int  which) const
inline

◆ deviceName()

const std::string & DigitalIoConnection::deviceName ( int  which) const

◆ doClone()

Referenced * DigitalIoConnection::doClone ( CloneMap cloneMap) const
overrideprotectedvirtual

◆ establishConnection()

bool DigitalIoConnection::establishConnection ( )

◆ hasDeviceInstances()

bool cnoid::DigitalIoConnection::hasDeviceInstances ( ) const
inline

◆ inBodyName()

const std::string& cnoid::DigitalIoConnection::inBodyName ( int  which) const
inline

◆ inDevice()

DigitalIoDevice* cnoid::DigitalIoConnection::inDevice ( )
inline

◆ inDeviceName()

const std::string& cnoid::DigitalIoConnection::inDeviceName ( int  which) const
inline

◆ inSignalIndex()

int cnoid::DigitalIoConnection::inSignalIndex ( ) const
inline

◆ note()

const std::string& cnoid::DigitalIoConnection::note ( )
inline

◆ outBodyName()

const std::string& cnoid::DigitalIoConnection::outBodyName ( int  which) const
inline

◆ outDevice()

DigitalIoDevice* cnoid::DigitalIoConnection::outDevice ( )
inline

◆ outDeviceName()

const std::string& cnoid::DigitalIoConnection::outDeviceName ( int  which) const
inline

◆ outSignalIndex()

int cnoid::DigitalIoConnection::outSignalIndex ( ) const
inline

◆ read()

bool DigitalIoConnection::read ( const Mapping archive)

◆ releaseConnection()

void DigitalIoConnection::releaseConnection ( )

◆ setDevice()

void DigitalIoConnection::setDevice ( int  which,
DigitalIoDevice device 
)

◆ setInDevice()

void cnoid::DigitalIoConnection::setInDevice ( DigitalIoDevice device)
inline

◆ setInSignalIndex()

void cnoid::DigitalIoConnection::setInSignalIndex ( int  index)
inline

◆ setNames()

void DigitalIoConnection::setNames ( int  which,
const std::string &  bodyName,
const std::string &  deviceName 
)

◆ setNote()

void cnoid::DigitalIoConnection::setNote ( const std::string &  note)
inline

◆ setOutDevice()

void cnoid::DigitalIoConnection::setOutDevice ( DigitalIoDevice device)
inline

◆ setOutSignalIndex()

void cnoid::DigitalIoConnection::setOutSignalIndex ( int  index)
inline

◆ setSignalIndex()

void cnoid::DigitalIoConnection::setSignalIndex ( int  which,
int  index 
)
inline

◆ signalIndex()

int cnoid::DigitalIoConnection::signalIndex ( int  which) const
inline

◆ write()

bool DigitalIoConnection::write ( Mapping archive) const

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